From ede1cc4c7ca4934403c0e02483d9a1e7d413c50c Mon Sep 17 00:00:00 2001 From: Paul Harrison Date: Thu, 7 Dec 2023 17:56:57 +0000 Subject: [PATCH] Deployed a998db0 with MkDocs version: 1.5.3 --- generated/javadoc/member-search-index.zip | Bin 21547 -> 21547 bytes generated/javadoc/package-search-index.zip | Bin 262 -> 262 bytes generated/javadoc/type-search-index.zip | Bin 1446 -> 1446 bytes index.html | 4 +++- search/search_index.json | 2 +- sitemap.xml.gz | Bin 127 -> 127 bytes 6 files changed, 4 insertions(+), 2 deletions(-) diff --git a/generated/javadoc/member-search-index.zip b/generated/javadoc/member-search-index.zip index 6ad36cf8c41c10b7b7f8362c181f266a99143fd5..dbddfbdbca4eb65bbe75ccf498d594c39da686ec 100644 GIT binary patch delta 30 mcmZ3zf^qcDetailed Documentation
  • ProposalManagementDM

    • Acknowledgement

    -

    Eu Flag This project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No 101004719

    +

    +EU Flag This project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No 101004719 +

    diff --git a/search/search_index.json b/search/search_index.json index b2db017..b4b00fe 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"ProposalDM","text":""},{"location":"#high-level-design-requirements","title":"High-level design requirements","text":"

    The proposal part model is primarily designed from the proposing astronomer's point-of-view, and does not contain all of the technical detail that would be necessary from the observatory point-of-view to actually perform detailed instrument set-up for instance, though it does strive to provide all the information necessary to schedule observations. Some top-level requirements that follow from this approach are;

    • The science goal is uppermost
    • specify the target objects.
    • necessary physics goals on the observation.
    • Specifics of instrumental configuration are not considered - only the broad physics of what the instrument should achieve

    In addition there are some other high level requirements of how the review should work that have driven the design;

    • It should be easy to reuse the proposal for many observatories.
    • Proposers should be anonymous to the reviewers (who indeed should be anonymous to the proposers).
    • Being able to use the proposal information on-line and off-line - to some extent this is the raison d'\u00eatre of a data model in providing a language to transfer information between systems.

    The proposal management part of the model adds extra information that the observatory needs to specify what resources are available and to provide a method of scoring the proposal. This is deliberately created as a separate part of the overall model to help to enforce the separation in functions so that the same proposal might be more easily submitted to several observatories.

    "},{"location":"#detailed-documentation","title":"Detailed Documentation","text":"

    Autogenerated documentation for the models

    • ProposalDM
    • ProposalManagementDM
    "},{"location":"#acknowledgement","title":"Acknowledgement","text":"

    This project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No 101004719

    "},{"location":"generated/STC_coords-v1.0.vo-dml/","title":"coords","text":"

    version 1.0 2022-02-10

    "},{"location":"generated/STC_coords-v1.0.vo-dml/#introduction","title":"Introduction","text":"

    This model defines objects which describe the coordinate space, coordinates within that space, and frames, which provide additional metadata regarding the origin, orientation, etc, of the coordinate space. The model also defines a coordinate system, bundling frames into associated groups. - note that this is an extended version for proposalDM including some concrete point types that will hopefully make it into the main release

    "},{"location":"generated/STC_coords-v1.0.vo-dml/#authors","title":"Authors","text":"

    Arnold Rots, Mark Cresitello-Dittmar, Omar Laurino

    "},{"location":"generated/STC_coords-v1.0.vo-dml/#overview-diagram","title":"Overview diagram","text":"

    The whole model is represented in a model diagram below

    GVmapcoords data modelcoords:Epoch <<primitive type>> Epoch coords:Handedness <<enumeration>> Handedness +left +right coords:PolStateEnum <<enumeration>> PolStateEnum +I +Q +U +V +RR +LL +RL +LR +XX +YY +XY +YX +PF +PP +PA coords:Coordinate <<datatype>> Coordinate coords:CoordSys CoordSys coords:Coordinate->coords:CoordSyscoordSys1coords:BinnedCoordinate <<datatype>> BinnedCoordinate +cval : ivoa:integer coords:BinnedCoordinate->coords:Coordinatecoords:PixelIndex <<datatype>> PixelIndex coords:PixelIndex->coords:BinnedCoordinatecoords:PhysicalCoordinate <<datatype>> PhysicalCoordinate +cval : ivoa:Quantity coords:PhysicalCoordinate->coords:Coordinatecoords:Point <<datatype>> Point +axis1 : ivoa:Quantity +axis2 : ivoa:Quantity +axis3 : ivoa:Quantity coords:Point->coords:Coordinatecoords:SphericalPoint <<datatype>> SphericalPoint +r : ivoa:RealQuantity +theta : ivoa:RealQuantity +phi : ivoa:RealQuantity coords:SphericalPoint->coords:Coordinatecoords:EquatorialPoint <<datatype>> EquatorialPoint +lon : ivoa:RealQuantity +lat : ivoa:RealQuantity coords:EquatorialPoint->coords:Coordinatecoords:GeocentricPoint <<datatype>> GeocentricPoint +x : ivoa:RealQuantity +y : ivoa:RealQuantity +z : ivoa:RealQuantity coords:GeocentricPoint->coords:Coordinatecoords:TimeStamp <<datatype>> TimeStamp coords:TimeStamp->coords:Coordinatecoords:TimeOffset <<datatype>> TimeOffset +time : ivoa:RealQuantity +time0 : coords:TimeInstant coords:TimeOffset->coords:TimeStampcoords:TimeInstant <<datatype>> TimeInstant coords:TimeInstant->coords:TimeStampcoords:JD <<datatype>> JD +date : ivoa:real coords:JD->coords:TimeInstantcoords:MJD <<datatype>> MJD +date : ivoa:real coords:MJD->coords:TimeInstantcoords:ISOTime <<datatype>> ISOTime +date : ivoa:datetime coords:ISOTime->coords:TimeInstantcoords:PolCoordinate <<datatype>> PolCoordinate coords:PolCoordinate->coords:Coordinatecoords:PolState <<datatype>> PolState +cval : coords:PolStateEnum coords:PolState->coords:PolCoordinatecoords:RefLocation <<datatype>> RefLocation coords:StdRefLocation <<datatype>> StdRefLocation +position : ivoa:string coords:StdRefLocation->coords:RefLocationcoords:CustomRefLocation <<datatype>> CustomRefLocation +epoch : coords:Epoch +position : coords:Point +velocity : coords:Point coords:CustomRefLocation->coords:RefLocationcoords:CoordSpace CoordSpace coords:Axis Axis +name : ivoa:string coords:CoordSpace->coords:Axisaxis1..*coords:ContinuousAxis ContinuousAxis +domainMin : ivoa:Quantity +domainMax : ivoa:Quantity +cyclic : ivoa:boolean coords:ContinuousAxis->coords:Axiscoords:BinnedAxis BinnedAxis +length : ivoa:nonnegativeInteger coords:BinnedAxis->coords:Axiscoords:DiscreteSetAxis DiscreteSetAxis coords:DiscreteSetAxis->coords:Axiscoords:CoordFrame CoordFrame coords:GenericFrame GenericFrame +refPosition : coords:RefLocation +planetaryEphem : ivoa:string coords:GenericFrame->coords:CoordFramecoords:SpaceFrame SpaceFrame +refPosition : coords:RefLocation +spaceRefFrame : ivoa:string +equinox : coords:Epoch +planetaryEphem : ivoa:string coords:SpaceFrame->coords:CoordFramecoords:TimeFrame TimeFrame +refPosition : coords:RefLocation +timescale : ivoa:string +refDirection : coords:RefLocation coords:TimeFrame->coords:CoordFramecoords:AstroCoordSystem AstroCoordSystem coords:AstroCoordSystem->coords:CoordSyscoords:PhysicalCoordSys PhysicalCoordSys coords:AstroCoordSystem->coords:PhysicalCoordSyscoordSys1..*coords:PixelCoordSystem PixelCoordSystem coords:PixelSpace PixelSpace +handedness : coords:Handedness coords:PixelCoordSystem->coords:PixelSpacepixelSpace1coords:PixelCoordSystem->coords:CoordSyscoords:PixelSpace->coords:CoordSpacecoords:PhysicalCoordSys->coords:CoordFrameframe0..1coords:PhysicalCoordSys->coords:CoordSyscoords:PhysicalCoordSpace PhysicalCoordSpace coords:PhysicalCoordSys->coords:PhysicalCoordSpacecoordSpace0..1coords:GenericSys GenericSys coords:GenericSys->coords:PhysicalCoordSyscoords:SpaceSys SpaceSys coords:SpaceSys->coords:PhysicalCoordSyscoords:TimeSys TimeSys coords:TimeSys->coords:PhysicalCoordSyscoords:PhysicalCoordSpace->coords:CoordSpacecoords:GenericCoordSpace GenericCoordSpace coords:GenericCoordSpace->coords:PhysicalCoordSpacecoords:SphericalCoordSpace SphericalCoordSpace coords:SphericalCoordSpace->coords:PhysicalCoordSpacecoords:CartesianCoordSpace CartesianCoordSpace coords:CartesianCoordSpace->coords:PhysicalCoordSpace"},{"location":"generated/STC_coords-v1.0.vo-dml/#primitives","title":"Primitives","text":"
    • Epoch
    "},{"location":"generated/STC_coords-v1.0.vo-dml/#enums","title":"Enums","text":"
    • Handedness
    • PolStateEnum
    "},{"location":"generated/STC_coords-v1.0.vo-dml/#datatypes","title":"DataTypes","text":"
    • BinnedCoordinate
    • Coordinate
    • CustomRefLocation
    • EquatorialPoint
    • GeocentricPoint
    • ISOTime
    • JD
    • MJD
    • PhysicalCoordinate
    • PixelIndex
    • Point
    • PolCoordinate
    • PolState
    • RefLocation
    • SphericalPoint
    • StdRefLocation
    • TimeInstant
    • TimeOffset
    • TimeStamp
    "},{"location":"generated/STC_coords-v1.0.vo-dml/#objecttypes","title":"ObjectTypes","text":"
    • AstroCoordSystem
    • Axis
    • BinnedAxis
    • CartesianCoordSpace
    • ContinuousAxis
    • CoordFrame
    • CoordSpace
    • CoordSys
    • DiscreteSetAxis
    • GenericCoordSpace
    • GenericFrame
    • GenericSys
    • PhysicalCoordSpace
    • PhysicalCoordSys
    • PixelCoordSystem
    • PixelSpace
    • SpaceFrame
    • SpaceSys
    • SphericalCoordSpace
    • TimeFrame
    • TimeSys
    "},{"location":"generated/STC_coords-v1.0.vo-dml/#imports","title":"Imports","text":"
    • ivoa
    "},{"location":"generated/proposalManagement.vo-dml/","title":"proposalManagement","text":"

    version 0.3 2023-04-21

    "},{"location":"generated/proposalManagement.vo-dml/#introduction","title":"Introduction","text":"

    The data model for managing the proposal review process. Intended to work for phase 1

    "},{"location":"generated/proposalManagement.vo-dml/#authors","title":"Authors","text":"

    Paul Harrison

    "},{"location":"generated/proposalManagement.vo-dml/#overview-diagram","title":"Overview diagram","text":"

    The whole model is represented in a model diagram below

    GVmapproposalManagement data modelproposal:ObservingMode proposal:ObservingMode proposal:Observatory proposal:Observatory proposal:Person proposal:Person proposal:ObservingProposal proposal:ObservingProposal proposalManagement:TacRole <<enumeration>> TacRole +TechnicalReviewer +ScienceReviewer +Chair proposalManagement:OfferedCycles OfferedCycles proposalManagement:ProposalCycle ProposalCycle +title : ivoa:string +submissionDeadline : ivoa:datetime +observationSessionStart : ivoa:datetime +observationSessionEnd : ivoa:datetime proposalManagement:OfferedCycles->proposalManagement:ProposalCyclecycles1..*proposalManagement:ProposalCycle->proposal:ObservingModeobservingModes1..*proposalManagement:ProposalCycle->proposal:Observatoryobservatory1proposalManagement:TAC TAC proposalManagement:ProposalCycle->proposalManagement:TACtac1proposalManagement:SubmittedProposal SubmittedProposal +submissionDate : ivoa:datetime proposalManagement:ProposalCycle->proposalManagement:SubmittedProposalsubmittedProposals0..*proposalManagement:ReviewedProposal ReviewedProposal +successful : ivoa:boolean +reviewsCompleteDate : ivoa:datetime proposalManagement:ProposalCycle->proposalManagement:ReviewedProposalreviewedProposals0..*proposalManagement:AllocatedProposal AllocatedProposal proposalManagement:ProposalCycle->proposalManagement:AllocatedProposalallocatedProposals0..*proposalManagement:AvailableResources AvailableResources proposalManagement:ProposalCycle->proposalManagement:AvailableResourcesavailableResources1proposalManagement:AllocationGrade AllocationGrade +name : ivoa:string +description : ivoa:string proposalManagement:ProposalCycle->proposalManagement:AllocationGradepossibleGrades1..*proposalManagement:Reviewer Reviewer proposalManagement:Reviewer->proposal:Personperson1proposalManagement:CommitteeMember CommitteeMember +role : proposalManagement:TacRole proposalManagement:CommitteeMember->proposalManagement:Reviewermember1proposalManagement:TAC->proposalManagement:CommitteeMembermembers1..*proposalManagement:SubmittedProposal->proposal:ObservingProposalproposal1proposalManagement:ReviewedProposal->proposalManagement:SubmittedProposalsubmitted1proposalManagement:ProposalReview ProposalReview +comment : ivoa:string +score : ivoa:real +technicalFeasibility : ivoa:boolean +reviewDate : ivoa:datetime proposalManagement:ReviewedProposal->proposalManagement:ProposalReviewreviews1..*proposalManagement:AllocatedProposal->proposalManagement:SubmittedProposalsubmitted1proposalManagement:AllocatedBlock AllocatedBlock proposalManagement:AllocatedProposal->proposalManagement:AllocatedBlockallocation1..*proposalManagement:ProposalReview->proposalManagement:Reviewerreviewer1proposalManagement:ResourceType ResourceType +name : ivoa:string +unit : ivoa:string proposalManagement:Resource Resource +amount : ivoa:real proposalManagement:Resource->proposalManagement:ResourceTypetype1proposalManagement:AvailableResources->proposalManagement:Resourceresources0..*proposalManagement:ResourceBlock ResourceBlock proposalManagement:ResourceBlock->proposal:ObservingModemode1proposalManagement:ResourceBlock->proposalManagement:Resourceresource1proposalManagement:AllocatedBlock->proposalManagement:AllocationGradegrade1proposalManagement:AllocatedBlock->proposalManagement:ResourceBlock"},{"location":"generated/proposalManagement.vo-dml/#enums","title":"Enums","text":"
    • TacRole
    "},{"location":"generated/proposalManagement.vo-dml/#objecttypes","title":"ObjectTypes","text":"
    • AllocatedBlock
    • AllocatedProposal
    • AllocationGrade
    • AvailableResources
    • CommitteeMember
    • OfferedCycles
    • ProposalCycle
    • ProposalReview
    • Resource
    • ResourceBlock
    • ResourceType
    • ReviewedProposal
    • Reviewer
    • SubmittedProposal
    • TAC
    "},{"location":"generated/proposalManagement.vo-dml/#imports","title":"Imports","text":"

    • ivoa

    • coords

    • proposal

    "},{"location":"generated/proposaldm.vo-dml/","title":"proposal","text":"

    version 0.3 2023-12-01

    "},{"location":"generated/proposaldm.vo-dml/#introduction","title":"Introduction","text":"

    A model to represent an application for observing time. The model is intended to express all of the concepts required to specify the scientific parameters of the application in sufficient detail to allow the proposal to be reviewed and allocated time. It does not cover all the technical detail of instrument setup that would be needed to actually schedule the observations, although the intention is that information about targets etc. could be automatically transferred to an observing system.

    "},{"location":"generated/proposaldm.vo-dml/#authors","title":"Authors","text":"

    Paul Harrison

    "},{"location":"generated/proposaldm.vo-dml/#overview-diagram","title":"Overview diagram","text":"

    The whole model is represented in a model diagram below

    GVmapproposal data modelproposal:WikiDataId <<primitive type>> WikiDataId proposal:ProposalKind <<enumeration>> ProposalKind +Standard +ToO +Survey proposal:InvestigatorKind <<enumeration>> InvestigatorKind +PI +COI proposal:InstrumentKind <<enumeration>> InstrumentKind +continuum +spectroscopic proposal:TextFormats <<enumeration>> TextFormats +latex +rst +asciidoc proposal:CalibrationTarget_intendedUse <<enumeration>> CalibrationTarget_intendedUse +Amplitude +Atmospheric +Bandpass +Phase +Pointing +Focus +Polarization +Delay proposal:ObservingProposal ObservingProposal +title : ivoa:string +summary : ivoa:string +kind : proposal:ProposalKind +submitted : ivoa:boolean proposal:RelatedProposal RelatedProposal proposal:ObservingProposal->proposal:RelatedProposalrelatedProposals0..*proposal:Investigator Investigator +type : proposal:InvestigatorKind +forPhD : ivoa:boolean proposal:ObservingProposal->proposal:Investigatorinvestigators1..*proposal:Justification Justification +text : ivoa:string +format : proposal:TextFormats proposal:ObservingProposal->proposal:JustificationscientificJustification1proposal:ObservingProposal->proposal:JustificationtechnicalJustification1proposal:SupportingDocument SupportingDocument +title : ivoa:string +location : ivoa:anyURI proposal:ObservingProposal->proposal:SupportingDocumentsupportingDocuments0..*proposal:Target Target +sourceName : ivoa:string proposal:ObservingProposal->proposal:Targettargets1..*proposal:Field Field +name : ivoa:string proposal:ObservingProposal->proposal:Fieldfields1..*proposal:Observation Observation proposal:ObservingProposal->proposal:Observationobservations1..*proposal:TechnicalGoal TechnicalGoal proposal:ObservingProposal->proposal:TechnicalGoaltechnicalGoals1..*proposal:RelatedProposal->proposal:ObservingProposalproposal1proposal:Person Person +fullName : ivoa:string +eMail : ivoa:string +orcidId : ivoa:stringIdentifier proposal:Organization Organization +name : ivoa:string +address : ivoa:string +ivoid : ivoa:ivorn +wikiId : proposal:WikiDataId proposal:Person->proposal:OrganizationhomeInstitute1proposal:Investigator->proposal:Personperson1proposal:Observatory Observatory proposal:Observatory->proposal:Organizationproposal:Telescope Telescope +name : ivoa:string +wikiId : proposal:WikiDataId +location : coords:GeocentricPoint proposal:Observatory->proposal:Telescopetelescopes1..*proposal:TelescopeArray TelescopeArray +name : ivoa:string proposal:Observatory->proposal:TelescopeArrayarrays0..*proposal:Instrument Instrument +name : ivoa:string +description : ivoa:string +wikiId : proposal:WikiDataId +reference : ivoa:anyURI +kind : proposal:InstrumentKind proposal:Observatory->proposal:Instrumentinstruments1..*proposal:Backend Backend +name : ivoa:string +parallel : ivoa:boolean proposal:Observatory->proposal:Backendbackends1..*proposal:TelescopeArrayMember TelescopeArrayMember proposal:TelescopeArrayMember->proposal:Telescopetelescope1proposal:TelescopeArray->proposal:TelescopeArrayMemberarrayMembers1..*proposal:SpectralWindowSetup SpectralWindowSetup +start : ivoa:RealQuantity +end : ivoa:RealQuantity +spectralResolution : ivoa:RealQuantity +isSkyFrequency : ivoa:boolean +polarization : coords:PolStateEnum proposal:Instrument->proposal:SpectralWindowSetupfrequencyCoverage1proposal:ObservingConfiguration ObservingConfiguration proposal:ObservingConfiguration->proposal:Telescopetelescope1proposal:ObservingConfiguration->proposal:Instrumentinstrument1proposal:ObservingConfiguration->proposal:Backendbackend1proposal:ObservingMode ObservingMode +name : ivoa:string +description : ivoa:string proposal:ObservingMode->proposal:ObservingConfigurationconfigurations1..*proposal:CelestialTarget CelestialTarget +sourceCoordinates : coords:EquatorialPoint +positionEpoch : coords:Epoch +pmRA : ivoa:RealQuantity +pmDec : ivoa:RealQuantity +parallax : ivoa:RealQuantity +sourceVelocity : ivoa:RealQuantity proposal:CelestialTarget->proposal:Targetproposal:SolarSystemTarget SolarSystemTarget proposal:SolarSystemTarget->proposal:Targetproposal:TargetField TargetField proposal:TargetField->proposal:Fieldproposal:Point Point +centre : coords:Point proposal:Point->proposal:Fieldproposal:Polygon Polygon +points : coords:EquatorialPoint proposal:Polygon->proposal:Fieldproposal:Ellipse Ellipse +semiMajor : ivoa:RealQuantity +semiMinor : ivoa:RealQuantity +pAMajor : ivoa:RealQuantity proposal:Ellipse->proposal:Fieldproposal:ObservingConstraint ObservingConstraint proposal:TimingConstraint TimingConstraint +note : ivoa:string +isAvoidConstraint : ivoa:boolean proposal:TimingConstraint->proposal:ObservingConstraintproposal:TimingWindow TimingWindow +startTime : ivoa:datetime +endTime : ivoa:datetime proposal:TimingWindow->proposal:TimingConstraintproposal:SimultaneityConstraint SimultaneityConstraint proposal:SimultaneityConstraint->proposal:TimingConstraintproposal:PointingConstaint PointingConstaint proposal:PointingConstaint->proposal:ObservingConstraintproposal:ScienceSpectralWindow ScienceSpectralWindow proposal:ScienceSpectralWindow->proposal:SpectralWindowSetupspectralWindowSetup0..1proposal:ExpectedSpectralLine ExpectedSpectralLine +restFrequency : ivoa:RealQuantity +transition : ivoa:string +splatalogId : ivoa:stringIdentifier +description : ivoa:string proposal:ScienceSpectralWindow->proposal:ExpectedSpectralLineexpectedSpectralLine0..*proposal:PerformanceParameters PerformanceParameters +desiredAngularResolution : ivoa:RealQuantity +desiredLargestScale : ivoa:RealQuantity +desiredSensitivity : ivoa:RealQuantity +desiredDynamicRange : ivoa:RealQuantity +representativeSpectralPoint : ivoa:RealQuantity proposal:Observation->proposal:Targettarget1proposal:Observation->proposal:Fieldfield1proposal:Observation->proposal:ObservingConstraintconstraints0..*proposal:Observation->proposal:TechnicalGoaltechnicalGoal1proposal:TargetObservation TargetObservation proposal:TargetObservation->proposal:Observationproposal:CalibrationObservation CalibrationObservation +intent : proposal:CalibrationTarget_intendedUse proposal:CalibrationObservation->proposal:Observationproposal:TechnicalGoal->proposal:ScienceSpectralWindowspectrum1..*proposal:TechnicalGoal->proposal:PerformanceParametersperformance1"},{"location":"generated/proposaldm.vo-dml/#primitives","title":"Primitives","text":"
    • WikiDataId
    "},{"location":"generated/proposaldm.vo-dml/#enums","title":"Enums","text":"
    • CalibrationTarget_intendedUse
    • InstrumentKind
    • InvestigatorKind
    • ProposalKind
    • TextFormats
    "},{"location":"generated/proposaldm.vo-dml/#objecttypes","title":"ObjectTypes","text":"
    • Backend
    • CalibrationObservation
    • CelestialTarget
    • Ellipse
    • ExpectedSpectralLine
    • Field
    • Instrument
    • Investigator
    • Justification
    • Observation
    • Observatory
    • ObservingConfiguration
    • ObservingConstraint
    • ObservingMode
    • ObservingProposal
    • Organization
    • PerformanceParameters
    • Person
    • Point
    • PointingConstaint
    • Polygon
    • RelatedProposal
    • ScienceSpectralWindow
    • SimultaneityConstraint
    • SolarSystemTarget
    • SpectralWindowSetup
    • SupportingDocument
    • Target
    • TargetField
    • TargetObservation
    • TechnicalGoal
    • Telescope
    • TelescopeArray
    • TelescopeArrayMember
    • TimingConstraint
    • TimingWindow
    "},{"location":"generated/proposaldm.vo-dml/#imports","title":"Imports","text":"

    • ivoa

    • coords

    "},{"location":"generated/coords/AstroCoordSystem/","title":"objectType AstroCoordSystem","text":"

    extends coords:CoordSys

    The AstroCoordSystem object holds a collection of component coordinate system descriptions across all represented physical domains.

    classDiagram\n\n        class AstroCoordSystem{\n\n        }\n        AstroCoordSystem --|> CoordSys\nAstroCoordSystem *-- PhysicalCoordSys : coordSys\n\n\n
    "},{"location":"generated/coords/AstroCoordSystem/#members","title":"Members","text":"name type mult description coordSys coords:PhysicalCoordSys 1 or more Coordinate system description for each physical domain (Space, Time, etc)."},{"location":"generated/coords/Axis/","title":"abstract objectType Axis","text":"

    The abstract parent class for all coordinate axis types. We provide concrete classes for the most common types of data, Continuous, Binned, and Discrete, but allow extension for other types as needed.

    classDiagram\n\n        class Axis{\n        ivoa:string name\n\n        }\n        ContinuousAxis --|> Axis\nBinnedAxis --|> Axis\nDiscreteSetAxis --|> Axis\n\n\n\n
    "},{"location":"generated/coords/Axis/#members","title":"Members","text":"name type mult description name ivoa:string optional Freeform string, provides the name or label for the axis."},{"location":"generated/coords/BinnedAxis/","title":"objectType BinnedAxis","text":"

    extends coords:Axis

    Axis description for binned data, where values along the axis correspond to a bin number.

    classDiagram\n\n        class BinnedAxis{\n        ivoa:nonnegativeInteger length\n\n        }\n        BinnedAxis --|> Axis\n\n
    "},{"location":"generated/coords/BinnedAxis/#members","title":"Members","text":"name type mult description length ivoa:nonnegativeInteger The length, or number of bins, along the axis."},{"location":"generated/coords/BinnedCoordinate/","title":"dataType BinnedCoordinate","text":"

    extends coords:Coordinate

    Coordinate value type specifically intended for binned data (e.g.: pixel indexes).

    classDiagram\n\n        class BinnedCoordinate{\n        ivoa:integer cval\n\n        }\n        BinnedCoordinate --|> Coordinate\nPixelIndex --|> BinnedCoordinate\n\n\n
    "},{"location":"generated/coords/BinnedCoordinate/#members","title":"Members","text":"name type mult description cval ivoa:integer The binned coordinate value, expressed as an integer. e.g.: bin number, pixel index."},{"location":"generated/coords/CartesianCoordSpace/","title":"objectType CartesianCoordSpace","text":"

    extends coords:PhysicalCoordSpace

    Spatial domain, three-dimensional cartesian coordinate space. The particulars of the axis descriptions depend on the physical constraints of the instance. In Appendix B, we provide the description of a Standard Cartesian Coordinate Space instance which applies to many Astronomical cases, and may be referenced in serializations.

    classDiagram\n\n        class CartesianCoordSpace{\n        coords:ContinuousAxis axis\n\n        }\n        CartesianCoordSpace --|> PhysicalCoordSpace\nPhysicalCoordSpace --|> CoordSpace\n\n\n
    "},{"location":"generated/coords/CartesianCoordSpace/#members","title":"Members","text":"name type mult description axis coords:ContinuousAxis subset"},{"location":"generated/coords/CartesianCoordSpace/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/CartesianCoordSpace/#axis","title":"axis","text":"

    Subsets axis in coords:CoordSpace from type coords:Axis to coords:ContinuousAxis

    "},{"location":"generated/coords/ContinuousAxis/","title":"objectType ContinuousAxis","text":"

    extends coords:Axis

    Axis description for continuous data. This object describes the domain for a particular axis of the domain space. It allows for the specification of the legal domain range (min,max), and a flag indicating if the axis is cyclic.

    classDiagram\n\n        class ContinuousAxis{\n        ivoa:Quantity domainMin\nivoa:Quantity domainMax\nivoa:boolean cyclic\n\n        }\n        ContinuousAxis --|> Axis\n\n
    "},{"location":"generated/coords/ContinuousAxis/#members","title":"Members","text":"name type mult description domainMin ivoa:Quantity optional Minimum extent of the axis domain space. If not provided, the domain space is considered to have no lower bound (-INFINITY). domainMax ivoa:Quantity optional Maximum extent of the axis domain space. If not provided, the domain space is considered to have no upper bound (+INFINITY). cyclic ivoa:boolean optional Flag indicating if the axis is cyclic in nature. If not provided, it is assumed to be FALSE."},{"location":"generated/coords/CoordFrame/","title":"abstract objectType CoordFrame","text":"

    This is the abstract, empty, base class for all coordinate frames. Coordinate frames provide metadata associated with the coordinate domain space. Typically, this will be related to the origin and orientation of the axes, but might include any metadata which pertains to the definition of the domain.

    classDiagram\n\n        class CoordFrame{\n\n        }\n        GenericFrame --|> CoordFrame\nSpaceFrame --|> CoordFrame\nTimeFrame --|> CoordFrame\n\n\n\n
    "},{"location":"generated/coords/CoordFrame/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/CoordSpace/","title":"abstract objectType CoordSpace","text":"

    This object defines a domain space. i.e.: it describes the set of possible coordinate values.

    classDiagram\n\n        class CoordSpace{\n\n        }\n        PixelSpace --|> CoordSpace\nPhysicalCoordSpace --|> CoordSpace\nCoordSpace *-- Axis : axis\n\n\n\n
    "},{"location":"generated/coords/CoordSpace/#members","title":"Members","text":"name type mult description axis coords:Axis 1 or more Describes an axis of the coordinate space."},{"location":"generated/coords/CoordSys/","title":"abstract objectType CoordSys","text":"

    Abstract head of the coordinate system object tree.

    classDiagram\n\n        class CoordSys{\n\n        }\n        AstroCoordSystem --|> CoordSys\nPixelCoordSystem --|> CoordSys\nPhysicalCoordSys --|> CoordSys\n\n\n\n
    "},{"location":"generated/coords/CoordSys/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/Coordinate/","title":"abstract dataType Coordinate","text":"

    Abstract base class for the Coordinate data types which represent an absolute location within a coordinate space. Coordinates MUST refer to a coordinate system, providing additional metadata relevant to interpreting the coordinate value, and its representation.

    classDiagram\n\n        class Coordinate{\n\n        }\n        BinnedCoordinate --|> Coordinate\nPhysicalCoordinate --|> Coordinate\nPoint --|> Coordinate\nSphericalPoint --|> Coordinate\nEquatorialPoint --|> Coordinate\nGeocentricPoint --|> Coordinate\nTimeStamp --|> Coordinate\nPolCoordinate --|> Coordinate\nCoordinate --> CoordSys : coordSys\n\n\n\n\n\n\n\n\n\n
    "},{"location":"generated/coords/Coordinate/#members","title":"Members","text":"name type mult description coordSys coords:CoordSys Provided additional metadata relevant to interpreting the coordinate value; for example, the spatial reference position, or time scale, axis descriptions."},{"location":"generated/coords/CustomRefLocation/","title":"dataType CustomRefLocation","text":"

    extends coords:RefLocation

    A custom reference location in phase space (position and velocity). Position and velocity are given as coordinates with an associated SpaceFrame. An epoch MAY be provided to further refine the location.

    classDiagram\n\n        class CustomRefLocation{\n        coords:Epoch epoch\ncoords:Point position\ncoords:Point velocity\n\n        }\n        CustomRefLocation --|> RefLocation\n\n
    "},{"location":"generated/coords/CustomRefLocation/#members","title":"Members","text":"name type mult description epoch coords:Epoch optional Epoch for the reference location. position coords:Point The spatial coordinates of the reference location. velocity coords:Point optional The velocity of the reference location."},{"location":"generated/coords/DiscreteSetAxis/","title":"objectType DiscreteSetAxis","text":"

    extends coords:Axis

    Axis type specifically intended for enumerated coordinates. Since the content and nature of this axis type is heavily dependent on the use case, we define no additional metadata here. Extensions of this type may include additional metadata relevant to the particular use cases. For example, an extension could include the allowed set of values.

    classDiagram\n\n        class DiscreteSetAxis{\n\n        }\n        DiscreteSetAxis --|> Axis\n\n
    "},{"location":"generated/coords/DiscreteSetAxis/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/Epoch/","title":"primitiveType Epoch","text":"

    We define epoch as a primitive data type with the expected form '$type$year' where type = 'J' or 'B' for Julian or Besselian respectively, and year is expressed as a decimal year. e.g.: 'B1950', 'J2000.0'

    "},{"location":"generated/coords/EquatorialPoint/","title":"dataType EquatorialPoint","text":"

    extends coords:Coordinate

    A Point on the Unit Sphere

    classDiagram\n\n        class EquatorialPoint{\n        coords:SpaceSys coordSys\nivoa:RealQuantity lon\nivoa:RealQuantity lat\n\n        }\n        EquatorialPoint --|> Coordinate\n\n
    "},{"location":"generated/coords/EquatorialPoint/#members","title":"Members","text":"name type mult description coordSys coords:SpaceSys subset lon ivoa:RealQuantity The longitudinal angle lat ivoa:RealQuantity The latitudinal angle"},{"location":"generated/coords/EquatorialPoint/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/EquatorialPoint/#coordsys","title":"coordSys","text":"

    Subsets coordSys in coords:Coordinate from type coords:CoordSys to coords:SpaceSys

    "},{"location":"generated/coords/GenericCoordSpace/","title":"objectType GenericCoordSpace","text":"

    extends coords:PhysicalCoordSpace

    Generic, one-dimensional coordinate space suitable for use with most non-spatial properties. In Appendix B, we provide the description of a Standard 1D Coordinate Space instance which may be referenced in serializations.

    classDiagram\n\n        class GenericCoordSpace{\n\n        }\n        GenericCoordSpace --|> PhysicalCoordSpace\nPhysicalCoordSpace --|> CoordSpace\n\n\n
    "},{"location":"generated/coords/GenericCoordSpace/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/GenericFrame/","title":"objectType GenericFrame","text":"

    extends coords:CoordFrame

    The generic coordinate frame is for cases where a domain-specific frame (e.g.: Space, Time), is not required, but the relevant reference metadata is still needed (e.g.: for Redshift or Spectral data)

    classDiagram\n\n        class GenericFrame{\n        coords:RefLocation refPosition\nivoa:string planetaryEphem\n\n        }\n        GenericFrame --|> CoordFrame\n\n
    "},{"location":"generated/coords/GenericFrame/#members","title":"Members","text":"name type mult description refPosition coords:RefLocation Spatial location in phase space (position and velocity) at which the observed value is considered to have been taken. This will typically be given by a standard reference position, but we allow for custom locations as well. planetaryEphem ivoa:string optional A planetary ephemeris MAY be provided, and SHOULD be provided whenever appropriate, to indicate which solar system ephemeris was used. If needed, but not provided, it is assumed to be 'DE405'"},{"location":"generated/coords/GenericSys/","title":"objectType GenericSys","text":"

    extends coords:PhysicalCoordSys

    Specialized coordinate system for generic, one-dimensional domains not covered by other, more concrete objects. If a CoordSpace is not provided, it is assumed to be represented by a Standard 1-Dimensional Coordinate Space as described in Appendix B.

    classDiagram\n\n        class GenericSys{\n        coords:GenericFrame frame\n\n        }\n        GenericSys --|> PhysicalCoordSys\nPhysicalCoordSys --|> CoordSys\n\n\n
    "},{"location":"generated/coords/GenericSys/#members","title":"Members","text":"name type mult description frame coords:GenericFrame subset"},{"location":"generated/coords/GenericSys/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/GenericSys/#frame","title":"frame","text":"

    Subsets frame in coords:PhysicalCoordSys from type coords:CoordFrame to coords:GenericFrame

    "},{"location":"generated/coords/GeocentricPoint/","title":"dataType GeocentricPoint","text":"

    extends coords:Coordinate

    ITRS earth coordinate

    classDiagram\n\n        class GeocentricPoint{\n        coords:SpaceSys coordSys\nivoa:RealQuantity x\nivoa:RealQuantity y\nivoa:RealQuantity z\n\n        }\n        GeocentricPoint --|> Coordinate\n\n
    "},{"location":"generated/coords/GeocentricPoint/#members","title":"Members","text":"name type mult description coordSys coords:SpaceSys subset x ivoa:RealQuantity cartesian x y ivoa:RealQuantity catesian y (+ve in east) z ivoa:RealQuantity cartesian z"},{"location":"generated/coords/GeocentricPoint/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/GeocentricPoint/#coordsys","title":"coordSys","text":"

    Subsets coordSys in coords:Coordinate from type coords:CoordSys to coords:SpaceSys

    "},{"location":"generated/coords/Handedness/","title":"enumeration Handedness","text":"

    The handedness of a coordinate space. For most cases, this will be a fixed value in the specification of the coordinate space. We provide this element to allow this flexibility when needed. In this document, it is used in the Pixel domain.

    classDiagram\n\n        class Handedness{\n           <<enumeration>>\nleft\nright\n\n        }\n
    "},{"location":"generated/coords/Handedness/#values","title":"Values","text":"

    • left - positive x and y axes point right and up, the positive z axis points inward

    • right - positive x and y axes point right and up, the positive z axis points outward

    "},{"location":"generated/coords/ISOTime/","title":"dataType ISOTime","text":"

    extends coords:TimeInstant

    Extension of TimeInstant for time expressed as a structured datetime string. The string representation of a datetime value should follow the FITS convention for representing dates (Hanish and Farris et al, 2001). The FITS standard is effectively ISO8601 format without the 'Z' tag to indicate UTC: YYYY-MM-DD['T'hh:mm:ss[.SSS]]. The TimeScale is provided in the associated TimeFrame.

    classDiagram\n\n        class ISOTime{\n        ivoa:datetime date\n\n        }\n        ISOTime --|> TimeInstant\nTimeInstant --|> TimeStamp\nTimeStamp --|> Coordinate\n\n\n\n
    "},{"location":"generated/coords/ISOTime/#members","title":"Members","text":"name type mult description date ivoa:datetime The ISOTime coordinate value."},{"location":"generated/coords/JD/","title":"dataType JD","text":"

    extends coords:TimeInstant

    Extension of TimeInstant for time expressed in Julian days. Note that JD does not properly specify a time stamp unless it is related to a time scale and reference position. Precision can easily become an issue with JD, as the numbers tend to be large.

    classDiagram\n\n        class JD{\n        ivoa:real date\n\n        }\n        JD --|> TimeInstant\nTimeInstant --|> TimeStamp\nTimeStamp --|> Coordinate\n\n\n\n
    "},{"location":"generated/coords/JD/#members","title":"Members","text":"name type mult description date ivoa:real The JD coordinate value. JD dates are dimensionless, with implied units in days."},{"location":"generated/coords/MJD/","title":"dataType MJD","text":"

    extends coords:TimeInstant

    Extension of TimeInstant for time expressed in Modified Julian Days. T(MJD) = T(JD) - 2400000.5.

    classDiagram\n\n        class MJD{\n        ivoa:real date\n\n        }\n        MJD --|> TimeInstant\nTimeInstant --|> TimeStamp\nTimeStamp --|> Coordinate\n\n\n\n
    "},{"location":"generated/coords/MJD/#members","title":"Members","text":"name type mult description date ivoa:real The MJD coordinate value. MJD dates are dimensionless, with implied units in days."},{"location":"generated/coords/PhysicalCoordSpace/","title":"abstract objectType PhysicalCoordSpace","text":"

    extends coords:CoordSpace

    Abstract head of coordinate spaces related to physical properties.

    classDiagram\n\n        class PhysicalCoordSpace{\n\n        }\n        PhysicalCoordSpace --|> CoordSpace\nGenericCoordSpace --|> PhysicalCoordSpace\nSphericalCoordSpace --|> PhysicalCoordSpace\nCartesianCoordSpace --|> PhysicalCoordSpace\n\n\n\n\n
    "},{"location":"generated/coords/PhysicalCoordSpace/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/PhysicalCoordSys/","title":"abstract objectType PhysicalCoordSys","text":"

    extends coords:CoordSys

    Coordinate system description for any physical domain, such as Time, Space, Redshift, Temperature, Flux, etc.

    classDiagram\n\n        class PhysicalCoordSys{\n\n        }\n        PhysicalCoordSys --|> CoordSys\nGenericSys --|> PhysicalCoordSys\nSpaceSys --|> PhysicalCoordSys\nTimeSys --|> PhysicalCoordSys\nPhysicalCoordSys *-- PhysicalCoordSpace : coordSpace\nPhysicalCoordSys *-- CoordFrame : frame\n\n\n\n\n\n\n
    "},{"location":"generated/coords/PhysicalCoordSys/#members","title":"Members","text":"name type mult description coordSpace coords:PhysicalCoordSpace optional Description of the coordinate space occupied by the property. frame coords:CoordFrame optional"},{"location":"generated/coords/PhysicalCoordinate/","title":"dataType PhysicalCoordinate","text":"

    extends coords:Coordinate

    The most common type of coordinate value. This type is appropriate for any data whose values can be described by an ivoa:Quantity (numeric, with unit).

    classDiagram\n\n        class PhysicalCoordinate{\n        ivoa:Quantity cval\n\n        }\n        PhysicalCoordinate --|> Coordinate\n\n
    "},{"location":"generated/coords/PhysicalCoordinate/#members","title":"Members","text":"name type mult description cval ivoa:Quantity This coordinate MUST contain a value expressed as an ivoa:Quantity."},{"location":"generated/coords/PixelCoordSystem/","title":"objectType PixelCoordSystem","text":"

    extends coords:CoordSys

    The PixelCoordSystem provides a complete description of the pixel coordinate space. It SHALL contain one PixelSpace instance describing each pixel axis.

    classDiagram\n\n        class PixelCoordSystem{\n\n        }\n        PixelCoordSystem --|> CoordSys\nPixelCoordSystem *-- PixelSpace : pixelSpace\n\n\n
    "},{"location":"generated/coords/PixelCoordSystem/#members","title":"Members","text":"name type mult description pixelSpace coords:PixelSpace The pixel space completely defines the pixel coordinate axes. Each axis MUST be defined as a BinnedAxis type."},{"location":"generated/coords/PixelIndex/","title":"dataType PixelIndex","text":"

    extends coords:BinnedCoordinate

    Specialized BinnedCoordinate for the pixel domain for a 1-dimensional pixel index. PixelIndex MUST refer to a PixelCoordSystem.

    classDiagram\n\n        class PixelIndex{\n\n        }\n        PixelIndex --|> BinnedCoordinate\nBinnedCoordinate --|> Coordinate\n\n\n
    "},{"location":"generated/coords/PixelIndex/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/PixelSpace/","title":"objectType PixelSpace","text":"

    extends coords:CoordSpace

    A PixelSpace SHALL include one or more BinnedAxis objects describing the pixel coordinate space. A handedness value MAY be provided to specify the relative orientation of the axes. 

    classDiagram\n\n        class PixelSpace{\n        coords:BinnedAxis axis\ncoords:Handedness handedness\n\n        }\n        PixelSpace --|> CoordSpace\n\n
    "},{"location":"generated/coords/PixelSpace/#members","title":"Members","text":"name type mult description axis coords:BinnedAxis subset handedness coords:Handedness optional Specifies the handedness of the coordinate space."},{"location":"generated/coords/PixelSpace/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/PixelSpace/#axis","title":"axis","text":"

    Subsets axis in coords:CoordSpace from type coords:Axis to coords:BinnedAxis

    "},{"location":"generated/coords/Point/","title":"dataType Point","text":"

    extends coords:Coordinate

    Multi-dimensional spatial coordinate. The Point MUST refer to a spatial coordinate system (SpaceSys). The coordinate values map, in order, to the axes described by the associated CoordSpace. Values for unused/undefined dimensions need not be provided.

    classDiagram\n\n        class Point{\n        coords:SpaceSys coordSys\nivoa:Quantity axis1\nivoa:Quantity axis2\nivoa:Quantity axis3\n\n        }\n        Point --|> Coordinate\n\n
    "},{"location":"generated/coords/Point/#members","title":"Members","text":"name type mult description coordSys coords:SpaceSys subset axis1 ivoa:Quantity optional Coordinate value along the first axis of the associated coordinate space, expressed as an ivoa:Quantity. axis2 ivoa:Quantity optional Coordinate value along the second axis of the associated coordinate space, expressed as an ivoa:Quantity. axis3 ivoa:Quantity optional Coordinate value along the third axis of the associated coordinate space, expressed as an ivoa:Quantity."},{"location":"generated/coords/Point/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/Point/#coordsys","title":"coordSys","text":"

    Subsets coordSys in coords:Coordinate from type coords:CoordSys to coords:SpaceSys

    "},{"location":"generated/coords/PolCoordinate/","title":"abstract dataType PolCoordinate","text":"

    extends coords:Coordinate

    Abstract head of the polarization coordinate types. Current use cases only require support for discrete polarization states, however, we include this head class to facilitate extension for other types (eg: polarization fraction and angle).

    classDiagram\n\n        class PolCoordinate{\n\n        }\n        PolCoordinate --|> Coordinate\nPolState --|> PolCoordinate\n\n\n
    "},{"location":"generated/coords/PolCoordinate/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/PolState/","title":"dataType PolState","text":"

    extends coords:PolCoordinate

    Coordinate type for discrete polarization states.

    classDiagram\n\n        class PolState{\n        coords:PolStateEnum cval\n\n        }\n        PolState --|> PolCoordinate\nPolCoordinate --|> Coordinate\n\n\n
    "},{"location":"generated/coords/PolState/#members","title":"Members","text":"name type mult description cval coords:PolStateEnum The coordinate value MUST be from the PolStateEnum enumerated set."},{"location":"generated/coords/PolStateEnum/","title":"enumeration PolStateEnum","text":"

    Polarization states: Stokes, Circular, Linear and Vector states

    classDiagram\n\n        class PolStateEnum{\n           <<enumeration>>\nI\nQ\nU\nV\nRR\nLL\nRL\nLR\nXX\nYY\nXY\nYX\nPF\nPP\nPA\n\n        }\n
    "},{"location":"generated/coords/PolStateEnum/#values","title":"Values","text":"

    • I -

    • Q -

    • U -

    • V -

    • RR -

    • LL -

    • RL -

    • LR -

    • XX -

    • YY -

    • XY -

    • YX -

    • PF -

    • PP -

    • PA -

    "},{"location":"generated/coords/RefLocation/","title":"abstract dataType RefLocation","text":"

    RefLocation defines the origin of the spatial coordinate space. This location is represented either by a standard reference position (for which the absolute location in phase space is known by definition), or a specified point in another Spatial frame. This object is used as the origin of the SpaceFrame here, but also to specify the Spatial Reference Position (refPosition) associated with other domain Frames. For example, in the Time domain, the Spatial Reference Position indicates that the 'time' values are the time that the 'event' occured at that location, which might be different from the detector location. 

    classDiagram\n\n        class RefLocation{\n\n        }\n        StdRefLocation --|> RefLocation\nCustomRefLocation --|> RefLocation\n\n\n
    "},{"location":"generated/coords/RefLocation/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/SpaceFrame/","title":"objectType SpaceFrame","text":"

    extends coords:CoordFrame

    A SpaceFrame is specified by its reference frame (orientation), and a reference position (origin). Currently only standard reference frames are allowed. An equinox MUST be provided for pre-ICRS reference frames. A planetary ephemeris MAY be provided if relevant. If needed, but not provided, it is assumed to be 'DE405'.

    classDiagram\n\n        class SpaceFrame{\n        coords:RefLocation refPosition\nivoa:string spaceRefFrame\ncoords:Epoch equinox\nivoa:string planetaryEphem\n\n        }\n        SpaceFrame --|> CoordFrame\n\n
    "},{"location":"generated/coords/SpaceFrame/#members","title":"Members","text":"name type mult description refPosition coords:RefLocation The spatial location at which the coordinates are considered to have been determined. This model supports locations provided as either a standard reference position (e.g. GEOCENTER), or a coordinate specifying a custom location (e.g. long, lat, height ). spaceRefFrame ivoa:string The spatial reference frame. Values MUST be selected from the controlled vocabulary at the given URL. equinox coords:Epoch optional Reference date for the frame, required for pre-ICRS reference frames. planetaryEphem ivoa:string optional Ephemeris file for solar system objects SHOULD be specified whenever relevant."},{"location":"generated/coords/SpaceSys/","title":"objectType SpaceSys","text":"

    extends coords:PhysicalCoordSys

    Specialized coordinate system for the Spatial domain. This object SHOULD include an appropriate SpaceFrame. In Appendix B, we define two standard spatial coordinate space instances (Spherical and Cartesian), which may be referenced in serializations. If a CoordSpace is not provided, it is assumed to be represented by a Standard Spherical Coordinate Space.

    classDiagram\n\n        class SpaceSys{\n        coords:SpaceFrame frame\n\n        }\n        SpaceSys --|> PhysicalCoordSys\nPhysicalCoordSys --|> CoordSys\n\n\n
    "},{"location":"generated/coords/SpaceSys/#members","title":"Members","text":"name type mult description frame coords:SpaceFrame subset"},{"location":"generated/coords/SpaceSys/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/SpaceSys/#frame","title":"frame","text":"

    Subsets frame in coords:PhysicalCoordSys from type coords:CoordFrame to coords:SpaceFrame

    "},{"location":"generated/coords/SphericalCoordSpace/","title":"objectType SphericalCoordSpace","text":"

    extends coords:PhysicalCoordSpace

    Spatial domain, three-dimensional spherical coordinate space. The particulars of the axis descriptions depend on the flavor of space being instantiated. In Appendix B., we provide a Standard Spherical Coordinate Space instance which applies to many Astronomical use cases. It provides the default space for SpaceSys instances, and may be referenced in serializations.

    classDiagram\n\n        class SphericalCoordSpace{\n        coords:ContinuousAxis axis\n\n        }\n        SphericalCoordSpace --|> PhysicalCoordSpace\nPhysicalCoordSpace --|> CoordSpace\n\n\n
    "},{"location":"generated/coords/SphericalCoordSpace/#members","title":"Members","text":"name type mult description axis coords:ContinuousAxis subset"},{"location":"generated/coords/SphericalCoordSpace/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/SphericalCoordSpace/#axis","title":"axis","text":"

    Subsets axis in coords:CoordSpace from type coords:Axis to coords:ContinuousAxis

    "},{"location":"generated/coords/SphericalPoint/","title":"dataType SphericalPoint","text":"

    extends coords:Coordinate

    A point in space expressed in spherical coordinates

    classDiagram\n\n        class SphericalPoint{\n        coords:SpaceSys coordSys\nivoa:RealQuantity r\nivoa:RealQuantity theta\nivoa:RealQuantity phi\n\n        }\n        SphericalPoint --|> Coordinate\n\n
    "},{"location":"generated/coords/SphericalPoint/#members","title":"Members","text":"name type mult description coordSys coords:SpaceSys subset r ivoa:RealQuantity radius theta ivoa:RealQuantity polar angle phi ivoa:RealQuantity azimuthal angle"},{"location":"generated/coords/SphericalPoint/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/SphericalPoint/#coordsys","title":"coordSys","text":"

    Subsets coordSys in coords:Coordinate from type coords:CoordSys to coords:SpaceSys

    "},{"location":"generated/coords/StdRefLocation/","title":"dataType StdRefLocation","text":"

    extends coords:RefLocation

    An absolute a-priori known location in phase space (position and velocity). Values are selected from the StdRefPosition vocabulary. Considering that the GEOCENTER is really the only place for which we know the absolute location at all times, all other locations require the specification of a planetary ephemeris. LSR[KD] are reserved for spectral and reshift frames. TOPOCENTER (location of the observer) is special in that it assumes that the observing location is available through other means (e.g. a geographic location or an orbit ephemeris). RELOCATABLE is available for simulations. UNKNOWN should only be used if absolutely necessary.

    classDiagram\n\n        class StdRefLocation{\n        ivoa:string position\n\n        }\n        StdRefLocation --|> RefLocation\n\n
    "},{"location":"generated/coords/StdRefLocation/#members","title":"Members","text":"name type mult description position ivoa:string Standard reference location. Values MUST be selected from the controlled vocabulary at the given URL."},{"location":"generated/coords/TimeFrame/","title":"objectType TimeFrame","text":"

    extends coords:CoordFrame

    A TimeFrame SHALL include a time scale and reference position. It MAY also include a reference direction.

    classDiagram\n\n        class TimeFrame{\n        coords:RefLocation refPosition\nivoa:string timescale\ncoords:RefLocation refDirection\n\n        }\n        TimeFrame --|> CoordFrame\n\n
    "},{"location":"generated/coords/TimeFrame/#members","title":"Members","text":"name type mult description refPosition coords:RefLocation The spatial location at which the coordinate is considered to have been taken. This model supports locations provided as either a standard reference position (e.g. GEOCENTER), or a coordinate specifying a custom location (e.g. long, lat, height). timescale ivoa:string The time scale sets the reference frame. The value MUST be selected from the controlled vocabulary at the given URL. refDirection coords:RefLocation optional The reference direction is needed if the time stamps are transformed to a time frame with a different reference position. In those situations, the solar system ephemeris also comes into play. See: FITS WCS Paper IV for details, but in short: The reference direction, presumably the direction to the thing being observed, is used in conjunction with the reference position and planetary ephemeris to determine the correction applied for the path length change. To be fully useful, one also needs to know the location at which the observation was made ( i.e. the observatory location), which is not considered to be Frame metadata."},{"location":"generated/coords/TimeInstant/","title":"abstract dataType TimeInstant","text":"

    extends coords:TimeStamp

    TimeStamps which specify a specific instant in time. We define three subtypes (ISOTime, JD, MJD), which allow users to explicitly identify the representation and interpretation of the TimeInstant.

    classDiagram\n\n        class TimeInstant{\n\n        }\n        TimeInstant --|> TimeStamp\nTimeStamp --|> Coordinate\nJD --|> TimeInstant\nMJD --|> TimeInstant\nISOTime --|> TimeInstant\n\n\n\n\n\n
    "},{"location":"generated/coords/TimeInstant/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/TimeOffset/","title":"dataType TimeOffset","text":"

    extends coords:TimeStamp

    Time is given as an offset from a specific point in time (time0).

    classDiagram\n\n        class TimeOffset{\n        ivoa:RealQuantity time\ncoords:TimeInstant time0\n\n        }\n        TimeOffset --|> TimeStamp\nTimeStamp --|> Coordinate\n\n\n
    "},{"location":"generated/coords/TimeOffset/#members","title":"Members","text":"name type mult description time ivoa:RealQuantity The TimeOffset coordinate value. time0 coords:TimeInstant The reference time from which the offset is calculated. This MUST be given as a TimeInstant (e.g.: JD, MJD, ISOTime)."},{"location":"generated/coords/TimeStamp/","title":"abstract dataType TimeStamp","text":"

    extends coords:Coordinate

    This is the abstract basis for a set of simple time domain coordinates which are expected to accommodate the vast majority of use cases. All TimeStamps, by definition, exist in a standard 1-D coordinate space, with domainMin|Max of +/-Infinity. All TimeStamps MUST refer to an appropriate TimeSys.

    classDiagram\n\n        class TimeStamp{\n        coords:TimeSys coordSys\n\n        }\n        TimeStamp --|> Coordinate\nTimeOffset --|> TimeStamp\nTimeInstant --|> TimeStamp\n\n\n\n
    "},{"location":"generated/coords/TimeStamp/#members","title":"Members","text":"name type mult description coordSys coords:TimeSys subset"},{"location":"generated/coords/TimeStamp/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/TimeStamp/#coordsys","title":"coordSys","text":"

    Subsets coordSys in coords:Coordinate from type coords:CoordSys to coords:TimeSys

    "},{"location":"generated/coords/TimeSys/","title":"objectType TimeSys","text":"

    extends coords:PhysicalCoordSys

    Specialized coordinate system for the Temporal domain. This object SHOULD include an appropriate TimeFrame. If a CoordSpace is not provided, it is assumed to be represented by a Standard 1-Dimensional Coordinate Space as described in Appendix B.

    classDiagram\n\n        class TimeSys{\n        coords:TimeFrame frame\ncoords:GenericCoordSpace coordSpace\n\n        }\n        TimeSys --|> PhysicalCoordSys\nPhysicalCoordSys --|> CoordSys\n\n\n
    "},{"location":"generated/coords/TimeSys/#members","title":"Members","text":"name type mult description frame coords:TimeFrame subset coordSpace coords:GenericCoordSpace subset"},{"location":"generated/coords/TimeSys/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/TimeSys/#frame","title":"frame","text":"

    Subsets frame in coords:PhysicalCoordSys from type coords:CoordFrame to coords:TimeFrame

    "},{"location":"generated/coords/TimeSys/#coordspace","title":"coordSpace","text":"

    Subsets coordSpace in coords:PhysicalCoordSys from type coords:PhysicalCoordSpace to coords:GenericCoordSpace

    "},{"location":"generated/proposal/Backend/","title":"objectType Backend","text":"

    a processing backend /pipeline- e.g. correlator

    classDiagram\n\n        class Backend{\n        ivoa:string name\nivoa:boolean parallel\n\n        }\n
    "},{"location":"generated/proposal/Backend/#members","title":"Members","text":"name type mult description name ivoa:string the backend name parallel ivoa:boolean is capable of being run at same time as other backends"},{"location":"generated/proposal/CalibrationObservation/","title":"objectType CalibrationObservation","text":"

    extends Observation

    An observation that is intended for calibration

    classDiagram\n\n        class CalibrationObservation{\n        proposal:CalibrationTarget_intendedUse intent\n\n        }\n        CalibrationObservation --|> Observation\n\nlink Observation \"../Observation\"
    "},{"location":"generated/proposal/CalibrationObservation/#members","title":"Members","text":"name type mult description intent CalibrationTarget_intendedUse The use of the calibration observation"},{"location":"generated/proposal/CalibrationTarget_intendedUse/","title":"enumeration CalibrationTarget_intendedUse","text":"
    classDiagram\n\n        class CalibrationTarget_intendedUse{\n           <<enumeration>>\nAmplitude\nAtmospheric\nBandpass\nPhase\nPointing\nFocus\nPolarization\nDelay\n\n        }\n
    "},{"location":"generated/proposal/CalibrationTarget_intendedUse/#values","title":"Values","text":"

    • Amplitude -

    • Atmospheric - used to measure atmospheric effects

    • Bandpass -

    • Phase -

    • Pointing -

    • Focus -

    • Polarization -

    • Delay -

    "},{"location":"generated/proposal/CelestialTarget/","title":"objectType CelestialTarget","text":"

    extends Target

    The basic target setup for a celestial Target.

    classDiagram\n\n        class CelestialTarget{\n        coords:EquatorialPoint sourceCoordinates\ncoords:Epoch positionEpoch\nivoa:RealQuantity pmRA\nivoa:RealQuantity pmDec\nivoa:RealQuantity parallax\nivoa:RealQuantity sourceVelocity\n\n        }\n        CelestialTarget --|> Target\n\nlink Target \"../Target\"
    "},{"location":"generated/proposal/CelestialTarget/#members","title":"Members","text":"name type mult description sourceCoordinates coords:EquatorialPoint positionEpoch coords:Epoch the epoch at which the position was measured pmRA ivoa:RealQuantity optional pmDec ivoa:RealQuantity optional parallax ivoa:RealQuantity optional sourceVelocity ivoa:RealQuantity optional"},{"location":"generated/proposal/Constraint/","title":"abstract objectType Constraint","text":"

    a form of constraint on the observation

    classDiagram\n\n        class Constraint{\n\n        }\n        TimingConstraint --|> Constraint\nPointingConstaint --|> Constraint\n\nlink TimingConstraint \"../TimingConstraint\"\nlink PointingConstaint \"../PointingConstaint\"
    "},{"location":"generated/proposal/Constraint/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/Ellipse/","title":"objectType Ellipse","text":"

    extends Field

    Specialization of a Field for an elliptical map.

    classDiagram\n\n        class Ellipse{\n        ivoa:RealQuantity semiMajor\nivoa:RealQuantity semiMinor\nivoa:RealQuantity pAMajor\n\n        }\n        Ellipse --|> Field\n\nlink Field \"../Field\"
    "},{"location":"generated/proposal/Ellipse/#members","title":"Members","text":"name type mult description semiMajor ivoa:RealQuantity semiMinor ivoa:RealQuantity pAMajor ivoa:RealQuantity"},{"location":"generated/proposal/ExpectedSpectralLine/","title":"objectType ExpectedSpectralLine","text":"

    Brief description of a spectral line.

    classDiagram\n\n        class ExpectedSpectralLine{\n        ivoa:RealQuantity restFrequency\nivoa:string transition\nivoa:stringIdentifier splatalogId\nivoa:string description\n\n        }\n
    "},{"location":"generated/proposal/ExpectedSpectralLine/#members","title":"Members","text":"name type mult description restFrequency ivoa:RealQuantity transition ivoa:string optional splatalogId ivoa:stringIdentifier description ivoa:string"},{"location":"generated/proposal/Field/","title":"abstract objectType Field","text":"

    Definition of an observing field pointing

    classDiagram\n\n        class Field{\n        ivoa:string name\n\n        }\n        TargetField --|> Field\nPoint --|> Field\nPolygon --|> Field\nEllipse --|> Field\n\nlink TargetField \"../TargetField\"\nlink Point \"../Point\"\nlink Polygon \"../Polygon\"\nlink Ellipse \"../Ellipse\"
    "},{"location":"generated/proposal/Field/#members","title":"Members","text":"name type mult description name ivoa:string"},{"location":"generated/proposal/Instrument/","title":"objectType Instrument","text":"

    An instrument that can be attached to a telescope - e.g. CCD, Radio Receiver

    classDiagram\n\n        class Instrument{\n        ivoa:string name\nivoa:string description\nproposal:WikiDataId wikiId\nivoa:anyURI reference\nproposal:InstrumentKind kind\n\n        }\n        Instrument *-- SpectralWindowSetup : frequencyCoverage\n\nlink SpectralWindowSetup \"../SpectralWindowSetup\"
    "},{"location":"generated/proposal/Instrument/#members","title":"Members","text":"name type mult description name ivoa:string the instrument name - human readable description ivoa:string optional short human readable description wikiId WikiDataId optional the wikidata id for the Instrument reference ivoa:anyURI optional a URL that points to a more detailed description of the instrument kind InstrumentKind the kind of instrument frequencyCoverage SpectralWindowSetup the frequency range that the instrument covers"},{"location":"generated/proposal/InstrumentKind/","title":"enumeration InstrumentKind","text":"
    classDiagram\n\n        class InstrumentKind{\n           <<enumeration>>\ncontinuum\nspectroscopic\n\n        }\n
    "},{"location":"generated/proposal/InstrumentKind/#values","title":"Values","text":"

    • continuum -

    • spectroscopic -

    "},{"location":"generated/proposal/Investigator/","title":"objectType Investigator","text":"
    classDiagram\n\n        class Investigator{\n        proposal:InvestigatorKind type\nivoa:boolean forPhD\n\n        }\n        Investigator --> Person : person\n\nlink Person \"../Person\"
    "},{"location":"generated/proposal/Investigator/#members","title":"Members","text":"name type mult description type InvestigatorKind the investigator type forPhD ivoa:boolean optional is the investigator making proposal for their PhD person Person the investigator"},{"location":"generated/proposal/InvestigatorKind/","title":"enumeration InvestigatorKind","text":"
    classDiagram\n\n        class InvestigatorKind{\n           <<enumeration>>\nPI\nCOI\n\n        }\n
    "},{"location":"generated/proposal/InvestigatorKind/#values","title":"Values","text":"

    • PI - principal investigator

    • COI - co-investigator

    "},{"location":"generated/proposal/Justification/","title":"objectType Justification","text":"

    The justification for the proposal. Note that the justification is for reading by humans and is not parsed to extract things like source lists - that sort of information must be entered in the correct place in the model.

    classDiagram\n\n        class Justification{\n        ivoa:string text\nproposal:TextFormats format\n\n        }\n
    "},{"location":"generated/proposal/Justification/#members","title":"Members","text":"name type mult description text ivoa:string the full text of the justification format TextFormats the format of the text"},{"location":"generated/proposal/Observation/","title":"abstract objectType Observation","text":"
    classDiagram\n\n        class Observation{\n\n        }\n        TargetObservation --|> Observation\nCalibrationObservation --|> Observation\nObservation --> Target : target\nObservation --> Field : field\nObservation --> TechnicalGoal : technicalGoal\nObservation *-- ObservingConstraint : constraints\n\nlink TargetObservation \"../TargetObservation\"\nlink CalibrationObservation \"../CalibrationObservation\"\nlink Target \"../Target\"\nlink Field \"../Field\"\nlink TechnicalGoal \"../TechnicalGoal\"\nlink ObservingConstraint \"../ObservingConstraint\"
    "},{"location":"generated/proposal/Observation/#members","title":"Members","text":"name type mult description constraints ObservingConstraint 0 or more any constraints on the observation target Target The actual target of the observation field Field The Field for the observation technicalGoal TechnicalGoal The technical goals of the observation"},{"location":"generated/proposal/Observatory/","title":"objectType Observatory","text":"

    extends Organization

    An organisation that can perform astronomical observations

    classDiagram\n\n        class Observatory{\n\n        }\n        Observatory --|> Organization\nObservatory *-- Telescope : telescopes\nObservatory *-- Instrument : instruments\nObservatory *-- Backend : backends\nObservatory *-- TelescopeArray : arrays\n\nlink Organization \"../Organization\"\nlink Telescope \"../Telescope\"\nlink Instrument \"../Instrument\"\nlink Backend \"../Backend\"\nlink TelescopeArray \"../TelescopeArray\"
    "},{"location":"generated/proposal/Observatory/#members","title":"Members","text":"name type mult description telescopes Telescope 1 or more the telescopes that the observatory controls instruments Instrument 1 or more the instruments that are available for the telescopes backends Backend 1 or more the backends that exist arrays TelescopeArray 0 or more any arrays of telescopes that typically operate together"},{"location":"generated/proposal/ObservingConfiguration/","title":"objectType ObservingConfiguration","text":"

    A particular observation combination that is possible

    classDiagram\n\n        class ObservingConfiguration{\n\n        }\n        ObservingConfiguration --> Telescope : telescope\nObservingConfiguration --> Instrument : instrument\nObservingConfiguration --> Backend : backend\n\nlink Telescope \"../Telescope\"\nlink Instrument \"../Instrument\"\nlink Backend \"../Backend\"
    "},{"location":"generated/proposal/ObservingConfiguration/#members","title":"Members","text":"name type mult description telescope Telescope instrument Instrument backend Backend"},{"location":"generated/proposal/ObservingConstraint/","title":"abstract objectType ObservingConstraint","text":"

    a form of constraint on the observation

    classDiagram\n\n        class ObservingConstraint{\n\n        }\n        TimingConstraint --|> ObservingConstraint\nPointingConstaint --|> ObservingConstraint\n\nlink TimingConstraint \"../TimingConstraint\"\nlink PointingConstaint \"../PointingConstaint\"
    "},{"location":"generated/proposal/ObservingConstraint/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/ObservingMode/","title":"objectType ObservingMode","text":"

    a collection of configs that can be chosen to observe with.

    classDiagram\n\n        class ObservingMode{\n        ivoa:string name\nivoa:string description\n\n        }\n        ObservingMode *-- ObservingConfiguration : configurations\n\nlink ObservingConfiguration \"../ObservingConfiguration\"
    "},{"location":"generated/proposal/ObservingMode/#members","title":"Members","text":"name type mult description name ivoa:string description ivoa:string configurations ObservingConfiguration 1 or more"},{"location":"generated/proposal/ObservingProposal/","title":"objectType ObservingProposal","text":"

    a complete proposal

    classDiagram\n\n        class ObservingProposal{\n        ivoa:string title\nivoa:string summary\nproposal:ProposalKind kind\nivoa:boolean submitted\n\n        }\n        ObservingProposal *-- Justification : scientificJustification\nObservingProposal *-- Justification : technicalJustification\nObservingProposal *-- Investigator : investigators\nObservingProposal *-- RelatedProposal : relatedProposals\nObservingProposal *-- SupportingDocument : supportingDocuments\nObservingProposal *-- Target : targets\nObservingProposal *-- Field : fields\nObservingProposal *-- TechnicalGoal : technicalGoals\nObservingProposal *-- Observation : observations\n\nlink Justification \"../Justification\"\nlink Justification \"../Justification\"\nlink Investigator \"../Investigator\"\nlink RelatedProposal \"../RelatedProposal\"\nlink SupportingDocument \"../SupportingDocument\"\nlink Target \"../Target\"\nlink Field \"../Field\"\nlink TechnicalGoal \"../TechnicalGoal\"\nlink Observation \"../Observation\"
    "},{"location":"generated/proposal/ObservingProposal/#members","title":"Members","text":"name type mult description title ivoa:string the proposal title summary ivoa:string a short summary/abstract of the proposal kind ProposalKind the type of proposal submitted ivoa:boolean optional whether the proposal is submitted scientificJustification Justification scientific justification technicalJustification Justification technical justification investigators Investigator 1 or more the person(s) making the proposal relatedProposals RelatedProposal 0 or more supportingDocuments SupportingDocument 0 or more any additional documents targets Target 1 or more the targets of the proposal fields Field 1 or more the fields observed in the proposal technicalGoals TechnicalGoal 1 or more the technical goals of the proposal observations Observation 1 or more the proposed observations"},{"location":"generated/proposal/Organization/","title":"objectType Organization","text":"

    An institution that is a collection of people

    classDiagram\n\n        class Organization{\n        ivoa:string name\nivoa:string address\nivoa:ivorn ivoid\nproposal:WikiDataId wikiId\n\n        }\n        Observatory --|> Organization\n\nlink Observatory \"../Observatory\"
    "},{"location":"generated/proposal/Organization/#members","title":"Members","text":"name type mult description name ivoa:string The name of the organization address ivoa:string ivoid ivoa:ivorn optional the registry identifier for the organization wikiId WikiDataId optional the wikidata id for the Organization"},{"location":"generated/proposal/PerformanceParameters/","title":"objectType PerformanceParameters","text":"

    The parameters required for observation to be useful for the science goal

    classDiagram\n\n        class PerformanceParameters{\n        ivoa:RealQuantity desiredAngularResolution\nivoa:RealQuantity desiredLargestScale\nivoa:RealQuantity desiredSensitivity\nivoa:RealQuantity desiredDynamicRange\nivoa:RealQuantity representativeSpectralPoint\n\n        }\n
    "},{"location":"generated/proposal/PerformanceParameters/#members","title":"Members","text":"name type mult description desiredAngularResolution ivoa:RealQuantity optional desiredLargestScale ivoa:RealQuantity optional desiredSensitivity ivoa:RealQuantity optional desiredDynamicRange ivoa:RealQuantity optional representativeSpectralPoint ivoa:RealQuantity the the point in the EM where these parameters should be evaluated"},{"location":"generated/proposal/Person/","title":"objectType Person","text":"

    person connected with the proposal

    classDiagram\n\n        class Person{\n        ivoa:string fullName\nivoa:string eMail\nivoa:stringIdentifier orcidId\n\n        }\n        Person --> Organization : homeInstitute\n\nlink Organization \"../Organization\"
    "},{"location":"generated/proposal/Person/#members","title":"Members","text":"name type mult description fullName ivoa:string The given names for the person eMail ivoa:string an email that can be used to communicate with the person orcidId ivoa:stringIdentifier optional orcid id see https://orcid.org homeInstitute Organization"},{"location":"generated/proposal/Point/","title":"objectType Point","text":"

    extends Field

    Single point on the sky

    classDiagram\n\n        class Point{\n        coords:Point centre\n\n        }\n        Point --|> Field\n\nlink Field \"../Field\"
    "},{"location":"generated/proposal/Point/#members","title":"Members","text":"name type mult description centre coords:Point"},{"location":"generated/proposal/PointingConstaint/","title":"abstract objectType PointingConstaint","text":"

    extends ObservingConstraint

    A constraint that limits the telescope pointing

    classDiagram\n\n        class PointingConstaint{\n\n        }\n        PointingConstaint --|> ObservingConstraint\n\nlink ObservingConstraint \"../ObservingConstraint\"
    "},{"location":"generated/proposal/PointingConstaint/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/Polygon/","title":"objectType Polygon","text":"

    extends Field

    Polygonal map

    classDiagram\n\n        class Polygon{\n        coords:EquatorialPoint points\n\n        }\n        Polygon --|> Field\n\nlink Field \"../Field\"
    "},{"location":"generated/proposal/Polygon/#members","title":"Members","text":"name type mult description points coords:EquatorialPoint 0 or more an array of points...."},{"location":"generated/proposal/ProposalKind/","title":"enumeration ProposalKind","text":"
    classDiagram\n\n        class ProposalKind{\n           <<enumeration>>\nStandard\nToO\nSurvey\n\n        }\n
    "},{"location":"generated/proposal/ProposalKind/#values","title":"Values","text":"

    • Standard - Normal proposal

    • ToO - target of opportunity

    • Survey - Part of a large programme

    "},{"location":"generated/proposal/RelatedProposal/","title":"objectType RelatedProposal","text":"

    a related proposal

    classDiagram\n\n        class RelatedProposal{\n\n        }\n        RelatedProposal --> ObservingProposal : proposal\n\nlink ObservingProposal \"../ObservingProposal\"
    "},{"location":"generated/proposal/RelatedProposal/#members","title":"Members","text":"name type mult description proposal ObservingProposal the related proposal"},{"location":"generated/proposal/ScienceSpectralWindow/","title":"objectType ScienceSpectralWindow","text":"

    A spectral window for science use.

    classDiagram\n\n        class ScienceSpectralWindow{\n\n        }\n        ScienceSpectralWindow *-- SpectralWindowSetup : spectralWindowSetup\nScienceSpectralWindow *-- ExpectedSpectralLine : expectedSpectralLine\n\nlink SpectralWindowSetup \"../SpectralWindowSetup\"\nlink ExpectedSpectralLine \"../ExpectedSpectralLine\"
    "},{"location":"generated/proposal/ScienceSpectralWindow/#members","title":"Members","text":"name type mult description spectralWindowSetup SpectralWindowSetup optional expectedSpectralLine ExpectedSpectralLine 0 or more"},{"location":"generated/proposal/SimultaneityConstraint/","title":"objectType SimultaneityConstraint","text":"

    extends TimingConstraint

    A constraint that requires that two observations occur simultaneously

    classDiagram\n\n        class SimultaneityConstraint{\n\n        }\n        SimultaneityConstraint --|> TimingConstraint\nTimingConstraint --|> ObservingConstraint\n\nlink TimingConstraint \"../TimingConstraint\"\nlink ObservingConstraint \"../ObservingConstraint\"
    "},{"location":"generated/proposal/SimultaneityConstraint/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/SolarSystemTarget/","title":"objectType SolarSystemTarget","text":"

    extends Target

    classDiagram\n\n        class SolarSystemTarget{\n\n        }\n        SolarSystemTarget --|> Target\n\nlink Target \"../Target\"
    "},{"location":"generated/proposal/SolarSystemTarget/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/SpectralWindowSetup/","title":"objectType SpectralWindowSetup","text":"

    Science oriented definition of a spectral window.

    classDiagram\n\n        class SpectralWindowSetup{\n        ivoa:RealQuantity start\nivoa:RealQuantity end\nivoa:RealQuantity spectralResolution\nivoa:boolean isSkyFrequency\ncoords:PolStateEnum polarization\n\n        }\n
    "},{"location":"generated/proposal/SpectralWindowSetup/#members","title":"Members","text":"name type mult description start ivoa:RealQuantity The start of the spectral window end ivoa:RealQuantity The end of the spectral window spectralResolution ivoa:RealQuantity optional channel width isSkyFrequency ivoa:boolean represents an observed frequency polarization coords:PolStateEnum desired polarization"},{"location":"generated/proposal/SupportingDocument/","title":"objectType SupportingDocument","text":"

    a document

    classDiagram\n\n        class SupportingDocument{\n        ivoa:string title\nivoa:anyURI location\n\n        }\n
    "},{"location":"generated/proposal/SupportingDocument/#members","title":"Members","text":"name type mult description title ivoa:string document title location ivoa:anyURI location of document"},{"location":"generated/proposal/Target/","title":"abstract objectType Target","text":"

    A target source

    classDiagram\n\n        class Target{\n        ivoa:string sourceName\n\n        }\n        CelestialTarget --|> Target\nSolarSystemTarget --|> Target\n\nlink CelestialTarget \"../CelestialTarget\"\nlink SolarSystemTarget \"../SolarSystemTarget\"
    "},{"location":"generated/proposal/Target/#members","title":"Members","text":"name type mult description sourceName ivoa:string A common name for the source"},{"location":"generated/proposal/TargetField/","title":"objectType TargetField","text":"

    extends Field

    the field points to the associated target

    classDiagram\n\n        class TargetField{\n\n        }\n        TargetField --|> Field\n\nlink Field \"../Field\"
    "},{"location":"generated/proposal/TargetField/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/TargetObservation/","title":"objectType TargetObservation","text":"

    extends Observation

    an observation of the scientific target 

    classDiagram\n\n        class TargetObservation{\n\n        }\n        TargetObservation --|> Observation\n\nlink Observation \"../Observation\"
    "},{"location":"generated/proposal/TargetObservation/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/TechnicalGoal/","title":"objectType TechnicalGoal","text":"

    collects together the technical goals of the proposal

    classDiagram\n\n        class TechnicalGoal{\n\n        }\n        TechnicalGoal *-- PerformanceParameters : performance\nTechnicalGoal *-- ScienceSpectralWindow : spectrum\n\nlink PerformanceParameters \"../PerformanceParameters\"\nlink ScienceSpectralWindow \"../ScienceSpectralWindow\"
    "},{"location":"generated/proposal/TechnicalGoal/#members","title":"Members","text":"name type mult description performance PerformanceParameters spectrum ScienceSpectralWindow 1 or more"},{"location":"generated/proposal/Telescope/","title":"objectType Telescope","text":"
    classDiagram\n\n        class Telescope{\n        ivoa:string name\nproposal:WikiDataId wikiId\ncoords:GeocentricPoint location\n\n        }\n
    "},{"location":"generated/proposal/Telescope/#members","title":"Members","text":"name type mult description name ivoa:string telescope name wikiId WikiDataId optional the wikidata id for the Instrument location coords:GeocentricPoint the location of the telescope"},{"location":"generated/proposal/TelescopeArray/","title":"objectType TelescopeArray","text":"

    a set of telescopes that are operated together for an observation

    classDiagram\n\n        class TelescopeArray{\n        ivoa:string name\n\n        }\n        TelescopeArray *-- TelescopeArrayMember : arrayMembers\n\nlink TelescopeArrayMember \"../TelescopeArrayMember\"
    "},{"location":"generated/proposal/TelescopeArray/#members","title":"Members","text":"name type mult description name ivoa:string the array name arrayMembers TelescopeArrayMember 1 or more the telescopes that make up the array"},{"location":"generated/proposal/TelescopeArrayMember/","title":"objectType TelescopeArrayMember","text":"
    classDiagram\n\n        class TelescopeArrayMember{\n\n        }\n        TelescopeArrayMember --> Telescope : telescope\n\nlink Telescope \"../Telescope\"
    "},{"location":"generated/proposal/TelescopeArrayMember/#members","title":"Members","text":"name type mult description telescope Telescope"},{"location":"generated/proposal/TextFormats/","title":"enumeration TextFormats","text":"

    acceptable text formats for document submission

    classDiagram\n\n        class TextFormats{\n           <<enumeration>>\nlatex\nrst\nasciidoc\n\n        }\n
    "},{"location":"generated/proposal/TextFormats/#values","title":"Values","text":"

    • latex - LaTeX using standard document style

    • rst - restructured text

    • asciidoc -

    "},{"location":"generated/proposal/TimingConstraint/","title":"abstract objectType TimingConstraint","text":"

    extends ObservingConstraint

    Any specific timing requirements for the observing

    classDiagram\n\n        class TimingConstraint{\n        ivoa:string note\nivoa:boolean isAvoidConstraint\n\n        }\n        TimingConstraint --|> ObservingConstraint\nTimingWindow --|> TimingConstraint\nSimultaneityConstraint --|> TimingConstraint\n\nlink ObservingConstraint \"../ObservingConstraint\"\nlink TimingWindow \"../TimingWindow\"\nlink SimultaneityConstraint \"../SimultaneityConstraint\"
    "},{"location":"generated/proposal/TimingConstraint/#members","title":"Members","text":"name type mult description note ivoa:string optional isAvoidConstraint ivoa:boolean optional"},{"location":"generated/proposal/TimingWindow/","title":"objectType TimingWindow","text":"

    extends TimingConstraint

    particular time range

    classDiagram\n\n        class TimingWindow{\n        ivoa:datetime startTime\nivoa:datetime endTime\n\n        }\n        TimingWindow --|> TimingConstraint\nTimingConstraint --|> ObservingConstraint\n\nlink TimingConstraint \"../TimingConstraint\"\nlink ObservingConstraint \"../ObservingConstraint\"
    "},{"location":"generated/proposal/TimingWindow/#members","title":"Members","text":"name type mult description startTime ivoa:datetime optional endTime ivoa:datetime optional"},{"location":"generated/proposal/WikiDataId/","title":"primitiveType WikiDataId","text":"

    a WikiData identifier

    "},{"location":"generated/proposalManagement/AllocatedBlock/","title":"objectType AllocatedBlock","text":"

    extends ResourceBlock

    A block of resources that have been allocated

    classDiagram\n\n        class AllocatedBlock{\n\n        }\n        AllocatedBlock --|> ResourceBlock\nAllocatedBlock --> AllocationGrade : grade\n\nlink ResourceBlock \"../ResourceBlock\"\nlink AllocationGrade \"../AllocationGrade\"
    "},{"location":"generated/proposalManagement/AllocatedBlock/#members","title":"Members","text":"name type mult description grade AllocationGrade"},{"location":"generated/proposalManagement/AllocatedProposal/","title":"objectType AllocatedProposal","text":"

    an instance of a proposal that is allocated observing time

    classDiagram\n\n        class AllocatedProposal{\n\n        }\n        AllocatedProposal --> SubmittedProposal : submitted\nAllocatedProposal *-- AllocatedBlock : allocation\n\nlink SubmittedProposal \"../SubmittedProposal\"\nlink AllocatedBlock \"../AllocatedBlock\"
    "},{"location":"generated/proposalManagement/AllocatedProposal/#members","title":"Members","text":"name type mult description allocation AllocatedBlock 1 or more what is allocated to the proposal submitted SubmittedProposal the proposal"},{"location":"generated/proposalManagement/AllocationGrade/","title":"objectType AllocationGrade","text":"

    The final grade given by the TAC

    classDiagram\n\n        class AllocationGrade{\n        ivoa:string name\nivoa:string description\n\n        }\n
    "},{"location":"generated/proposalManagement/AllocationGrade/#members","title":"Members","text":"name type mult description name ivoa:string the name of the grade description ivoa:string what this grade means"},{"location":"generated/proposalManagement/AvailableResources/","title":"objectType AvailableResources","text":"

    The list of resources that are available

    classDiagram\n\n        class AvailableResources{\n\n        }\n        AvailableResources *-- Resource : resources\n\nlink Resource \"../Resource\"
    "},{"location":"generated/proposalManagement/AvailableResources/#members","title":"Members","text":"name type mult description resources Resource 0 or more"},{"location":"generated/proposalManagement/CommitteeMember/","title":"objectType CommitteeMember","text":"

    a member of the TAC 

    classDiagram\n\n        class CommitteeMember{\n        proposalManagement:TacRole role\n\n        }\n        CommitteeMember --> Reviewer : member\n\nlink Reviewer \"../Reviewer\"
    "},{"location":"generated/proposalManagement/CommitteeMember/#members","title":"Members","text":"name type mult description role TacRole member Reviewer the member"},{"location":"generated/proposalManagement/OfferedCycles/","title":"objectType OfferedCycles","text":"
    classDiagram\n\n        class OfferedCycles{\n\n        }\n        OfferedCycles *-- ProposalCycle : cycles\n\nlink ProposalCycle \"../ProposalCycle\"
    "},{"location":"generated/proposalManagement/OfferedCycles/#members","title":"Members","text":"name type mult description cycles ProposalCycle 1 or more"},{"location":"generated/proposalManagement/ProposalCycle/","title":"objectType ProposalCycle","text":"

    Defines collection of resources and proposals for a particular observing season

    classDiagram\n\n        class ProposalCycle{\n        ivoa:string title\nivoa:datetime submissionDeadline\nivoa:datetime observationSessionStart\nivoa:datetime observationSessionEnd\n\n        }\n        ProposalCycle --> Observatory : observatory\nProposalCycle *-- ObservingMode : observingModes\nProposalCycle *-- AvailableResources : availableResources\nProposalCycle *-- AllocationGrade : possibleGrades\nProposalCycle *-- TAC : tac\nProposalCycle *-- SubmittedProposal : submittedProposals\nProposalCycle *-- ReviewedProposal : reviewedProposals\nProposalCycle *-- AllocatedProposal : allocatedProposals\n\nlink Observatory \"../../proposal/Observatory\"\nlink ObservingMode \"../../proposal/ObservingMode\"\nlink AvailableResources \"../AvailableResources\"\nlink AllocationGrade \"../AllocationGrade\"\nlink TAC \"../TAC\"\nlink SubmittedProposal \"../SubmittedProposal\"\nlink ReviewedProposal \"../ReviewedProposal\"\nlink AllocatedProposal \"../AllocatedProposal\"
    "},{"location":"generated/proposalManagement/ProposalCycle/#members","title":"Members","text":"name type mult description title ivoa:string a human readable description of the cycle submissionDeadline ivoa:datetime the date by which observing proposals must be submitted to be considered for this cycle observationSessionStart ivoa:datetime the start date of the observing cycle observationSessionEnd ivoa:datetime the end date of the observing cycle observingModes proposal:ObservingMode 1 or more the possible observing modes offered in the cycle availableResources AvailableResources possibleGrades AllocationGrade 1 or more The possible grades that can be allocated for this cycle tac TAC The time allocation committee submittedProposals SubmittedProposal 0 or more the proposals that have been submitted in this cycle reviewedProposals ReviewedProposal 0 or more the proposals that have been reviewed in this cycle allocatedProposals AllocatedProposal 0 or more the proposals that have been successful and allocated time observatory proposal:Observatory"},{"location":"generated/proposalManagement/ProposalReview/","title":"objectType ProposalReview","text":"

    A review of a proposal

    classDiagram\n\n        class ProposalReview{\n        ivoa:string comment\nivoa:real score\nivoa:boolean technicalFeasibility\nivoa:datetime reviewDate\n\n        }\n        ProposalReview --> Reviewer : reviewer\n\nlink Reviewer \"../Reviewer\"
    "},{"location":"generated/proposalManagement/ProposalReview/#members","title":"Members","text":"name type mult description comment ivoa:string Description score ivoa:real the review score technicalFeasibility ivoa:boolean is the proposal technically feasible reviewDate ivoa:datetime the date that the review is submitted reviewer Reviewer the reviewer making this review"},{"location":"generated/proposalManagement/Resource/","title":"objectType Resource","text":"

    A resource that will be consumed by allocating an observation from a proposal

    classDiagram\n\n        class Resource{\n        ivoa:real amount\n\n        }\n        Resource --> ResourceType : type\n\nlink ResourceType \"../ResourceType\"
    "},{"location":"generated/proposalManagement/Resource/#members","title":"Members","text":"name type mult description amount ivoa:real The amount of the resource type ResourceType the type of the resource"},{"location":"generated/proposalManagement/ResourceBlock/","title":"objectType ResourceBlock","text":"

    A block of resources that can be allocated

    classDiagram\n\n        class ResourceBlock{\n\n        }\n        AllocatedBlock --|> ResourceBlock\nResourceBlock --> ObservingMode : mode\nResourceBlock *-- Resource : resource\n\nlink AllocatedBlock \"../AllocatedBlock\"\nlink ObservingMode \"../../proposal/ObservingMode\"\nlink Resource \"../Resource\"
    "},{"location":"generated/proposalManagement/ResourceBlock/#members","title":"Members","text":"name type mult description resource Resource the amount of resource mode proposal:ObservingMode"},{"location":"generated/proposalManagement/ResourceType/","title":"objectType ResourceType","text":"

    a type of resource 

    classDiagram\n\n        class ResourceType{\n        ivoa:string name\nivoa:string unit\n\n        }\n
    "},{"location":"generated/proposalManagement/ResourceType/#members","title":"Members","text":"name type mult description name ivoa:string the name of the resource type unit ivoa:string"},{"location":"generated/proposalManagement/ReviewedProposal/","title":"objectType ReviewedProposal","text":"

    an instance of a proposal that is in review

    classDiagram\n\n        class ReviewedProposal{\n        ivoa:boolean successful\nivoa:datetime reviewsCompleteDate\n\n        }\n        ReviewedProposal --> SubmittedProposal : submitted\nReviewedProposal *-- ProposalReview : reviews\n\nlink SubmittedProposal \"../SubmittedProposal\"\nlink ProposalReview \"../ProposalReview\"
    "},{"location":"generated/proposalManagement/ReviewedProposal/#members","title":"Members","text":"name type mult description successful ivoa:boolean the proposal can go on to allocation reviewsCompleteDate ivoa:datetime the date when all the proposals are due reviews ProposalReview 1 or more the reviews submitted SubmittedProposal"},{"location":"generated/proposalManagement/Reviewer/","title":"objectType Reviewer","text":"

    assigned to review the proposal

    classDiagram\n\n        class Reviewer{\n\n        }\n        Reviewer --> Person : person\n\nlink Person \"../../proposal/Person\"
    "},{"location":"generated/proposalManagement/Reviewer/#members","title":"Members","text":"name type mult description person proposal:Person the person taking on the reviewer role"},{"location":"generated/proposalManagement/SubmittedProposal/","title":"objectType SubmittedProposal","text":"

    an instance of a proposal that has been submitted

    classDiagram\n\n        class SubmittedProposal{\n        ivoa:datetime submissionDate\n\n        }\n        SubmittedProposal --> ObservingProposal : proposal\n\nlink ObservingProposal \"../../proposal/ObservingProposal\"
    "},{"location":"generated/proposalManagement/SubmittedProposal/#members","title":"Members","text":"name type mult description submissionDate ivoa:datetime the date that the proposal was submitted proposal proposal:ObservingProposal the proposal that was submitted"},{"location":"generated/proposalManagement/TAC/","title":"objectType TAC","text":"

    time allocation committee

    classDiagram\n\n        class TAC{\n\n        }\n        TAC *-- CommitteeMember : members\n\nlink CommitteeMember \"../CommitteeMember\"
    "},{"location":"generated/proposalManagement/TAC/#members","title":"Members","text":"name type mult description members CommitteeMember 1 or more members of the committee"},{"location":"generated/proposalManagement/TacRole/","title":"enumeration TacRole","text":"

    A role within the timeAllocation committee

    classDiagram\n\n        class TacRole{\n           <<enumeration>>\nTechnicalReviewer\nScienceReviewer\nChair\n\n        }\n
    "},{"location":"generated/proposalManagement/TacRole/#values","title":"Values","text":"

    • TechnicalReviewer -

    • ScienceReviewer -

    • Chair -

    "}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"ProposalDM","text":""},{"location":"#high-level-design-requirements","title":"High-level design requirements","text":"

    The proposal part model is primarily designed from the proposing astronomer's point-of-view, and does not contain all of the technical detail that would be necessary from the observatory point-of-view to actually perform detailed instrument set-up for instance, though it does strive to provide all the information necessary to schedule observations. Some top-level requirements that follow from this approach are;

    • The science goal is uppermost
    • specify the target objects.
    • necessary physics goals on the observation.
    • Specifics of instrumental configuration are not considered - only the broad physics of what the instrument should achieve

    In addition there are some other high level requirements of how the review should work that have driven the design;

    • It should be easy to reuse the proposal for many observatories.
    • Proposers should be anonymous to the reviewers (who indeed should be anonymous to the proposers).
    • Being able to use the proposal information on-line and off-line - to some extent this is the raison d'\u00eatre of a data model in providing a language to transfer information between systems.

    The proposal management part of the model adds extra information that the observatory needs to specify what resources are available and to provide a method of scoring the proposal. This is deliberately created as a separate part of the overall model to help to enforce the separation in functions so that the same proposal might be more easily submitted to several observatories.

    "},{"location":"#detailed-documentation","title":"Detailed Documentation","text":"

    Autogenerated documentation for the models

    • ProposalDM
    • ProposalManagementDM
    "},{"location":"#acknowledgement","title":"Acknowledgement","text":"

    This project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No 101004719

    "},{"location":"generated/STC_coords-v1.0.vo-dml/","title":"coords","text":"

    version 1.0 2022-02-10

    "},{"location":"generated/STC_coords-v1.0.vo-dml/#introduction","title":"Introduction","text":"

    This model defines objects which describe the coordinate space, coordinates within that space, and frames, which provide additional metadata regarding the origin, orientation, etc, of the coordinate space. The model also defines a coordinate system, bundling frames into associated groups. - note that this is an extended version for proposalDM including some concrete point types that will hopefully make it into the main release

    "},{"location":"generated/STC_coords-v1.0.vo-dml/#authors","title":"Authors","text":"

    Arnold Rots, Mark Cresitello-Dittmar, Omar Laurino

    "},{"location":"generated/STC_coords-v1.0.vo-dml/#overview-diagram","title":"Overview diagram","text":"

    The whole model is represented in a model diagram below

    GVmapcoords data modelcoords:Epoch <<primitive type>> Epoch coords:Handedness <<enumeration>> Handedness +left +right coords:PolStateEnum <<enumeration>> PolStateEnum +I +Q +U +V +RR +LL +RL +LR +XX +YY +XY +YX +PF +PP +PA coords:Coordinate <<datatype>> Coordinate coords:CoordSys CoordSys coords:Coordinate->coords:CoordSyscoordSys1coords:BinnedCoordinate <<datatype>> BinnedCoordinate +cval : ivoa:integer coords:BinnedCoordinate->coords:Coordinatecoords:PixelIndex <<datatype>> PixelIndex coords:PixelIndex->coords:BinnedCoordinatecoords:PhysicalCoordinate <<datatype>> PhysicalCoordinate +cval : ivoa:Quantity coords:PhysicalCoordinate->coords:Coordinatecoords:Point <<datatype>> Point +axis1 : ivoa:Quantity +axis2 : ivoa:Quantity +axis3 : ivoa:Quantity coords:Point->coords:Coordinatecoords:SphericalPoint <<datatype>> SphericalPoint +r : ivoa:RealQuantity +theta : ivoa:RealQuantity +phi : ivoa:RealQuantity coords:SphericalPoint->coords:Coordinatecoords:EquatorialPoint <<datatype>> EquatorialPoint +lon : ivoa:RealQuantity +lat : ivoa:RealQuantity coords:EquatorialPoint->coords:Coordinatecoords:GeocentricPoint <<datatype>> GeocentricPoint +x : ivoa:RealQuantity +y : ivoa:RealQuantity +z : ivoa:RealQuantity coords:GeocentricPoint->coords:Coordinatecoords:TimeStamp <<datatype>> TimeStamp coords:TimeStamp->coords:Coordinatecoords:TimeOffset <<datatype>> TimeOffset +time : ivoa:RealQuantity +time0 : coords:TimeInstant coords:TimeOffset->coords:TimeStampcoords:TimeInstant <<datatype>> TimeInstant coords:TimeInstant->coords:TimeStampcoords:JD <<datatype>> JD +date : ivoa:real coords:JD->coords:TimeInstantcoords:MJD <<datatype>> MJD +date : ivoa:real coords:MJD->coords:TimeInstantcoords:ISOTime <<datatype>> ISOTime +date : ivoa:datetime coords:ISOTime->coords:TimeInstantcoords:PolCoordinate <<datatype>> PolCoordinate coords:PolCoordinate->coords:Coordinatecoords:PolState <<datatype>> PolState +cval : coords:PolStateEnum coords:PolState->coords:PolCoordinatecoords:RefLocation <<datatype>> RefLocation coords:StdRefLocation <<datatype>> StdRefLocation +position : ivoa:string coords:StdRefLocation->coords:RefLocationcoords:CustomRefLocation <<datatype>> CustomRefLocation +epoch : coords:Epoch +position : coords:Point +velocity : coords:Point coords:CustomRefLocation->coords:RefLocationcoords:CoordSpace CoordSpace coords:Axis Axis +name : ivoa:string coords:CoordSpace->coords:Axisaxis1..*coords:ContinuousAxis ContinuousAxis +domainMin : ivoa:Quantity +domainMax : ivoa:Quantity +cyclic : ivoa:boolean coords:ContinuousAxis->coords:Axiscoords:BinnedAxis BinnedAxis +length : ivoa:nonnegativeInteger coords:BinnedAxis->coords:Axiscoords:DiscreteSetAxis DiscreteSetAxis coords:DiscreteSetAxis->coords:Axiscoords:CoordFrame CoordFrame coords:GenericFrame GenericFrame +refPosition : coords:RefLocation +planetaryEphem : ivoa:string coords:GenericFrame->coords:CoordFramecoords:SpaceFrame SpaceFrame +refPosition : coords:RefLocation +spaceRefFrame : ivoa:string +equinox : coords:Epoch +planetaryEphem : ivoa:string coords:SpaceFrame->coords:CoordFramecoords:TimeFrame TimeFrame +refPosition : coords:RefLocation +timescale : ivoa:string +refDirection : coords:RefLocation coords:TimeFrame->coords:CoordFramecoords:AstroCoordSystem AstroCoordSystem coords:AstroCoordSystem->coords:CoordSyscoords:PhysicalCoordSys PhysicalCoordSys coords:AstroCoordSystem->coords:PhysicalCoordSyscoordSys1..*coords:PixelCoordSystem PixelCoordSystem coords:PixelSpace PixelSpace +handedness : coords:Handedness coords:PixelCoordSystem->coords:PixelSpacepixelSpace1coords:PixelCoordSystem->coords:CoordSyscoords:PixelSpace->coords:CoordSpacecoords:PhysicalCoordSys->coords:CoordFrameframe0..1coords:PhysicalCoordSys->coords:CoordSyscoords:PhysicalCoordSpace PhysicalCoordSpace coords:PhysicalCoordSys->coords:PhysicalCoordSpacecoordSpace0..1coords:GenericSys GenericSys coords:GenericSys->coords:PhysicalCoordSyscoords:SpaceSys SpaceSys coords:SpaceSys->coords:PhysicalCoordSyscoords:TimeSys TimeSys coords:TimeSys->coords:PhysicalCoordSyscoords:PhysicalCoordSpace->coords:CoordSpacecoords:GenericCoordSpace GenericCoordSpace coords:GenericCoordSpace->coords:PhysicalCoordSpacecoords:SphericalCoordSpace SphericalCoordSpace coords:SphericalCoordSpace->coords:PhysicalCoordSpacecoords:CartesianCoordSpace CartesianCoordSpace coords:CartesianCoordSpace->coords:PhysicalCoordSpace"},{"location":"generated/STC_coords-v1.0.vo-dml/#primitives","title":"Primitives","text":"
    • Epoch
    "},{"location":"generated/STC_coords-v1.0.vo-dml/#enums","title":"Enums","text":"
    • Handedness
    • PolStateEnum
    "},{"location":"generated/STC_coords-v1.0.vo-dml/#datatypes","title":"DataTypes","text":"
    • BinnedCoordinate
    • Coordinate
    • CustomRefLocation
    • EquatorialPoint
    • GeocentricPoint
    • ISOTime
    • JD
    • MJD
    • PhysicalCoordinate
    • PixelIndex
    • Point
    • PolCoordinate
    • PolState
    • RefLocation
    • SphericalPoint
    • StdRefLocation
    • TimeInstant
    • TimeOffset
    • TimeStamp
    "},{"location":"generated/STC_coords-v1.0.vo-dml/#objecttypes","title":"ObjectTypes","text":"
    • AstroCoordSystem
    • Axis
    • BinnedAxis
    • CartesianCoordSpace
    • ContinuousAxis
    • CoordFrame
    • CoordSpace
    • CoordSys
    • DiscreteSetAxis
    • GenericCoordSpace
    • GenericFrame
    • GenericSys
    • PhysicalCoordSpace
    • PhysicalCoordSys
    • PixelCoordSystem
    • PixelSpace
    • SpaceFrame
    • SpaceSys
    • SphericalCoordSpace
    • TimeFrame
    • TimeSys
    "},{"location":"generated/STC_coords-v1.0.vo-dml/#imports","title":"Imports","text":"
    • ivoa
    "},{"location":"generated/proposalManagement.vo-dml/","title":"proposalManagement","text":"

    version 0.3 2023-04-21

    "},{"location":"generated/proposalManagement.vo-dml/#introduction","title":"Introduction","text":"

    The data model for managing the proposal review process. Intended to work for phase 1

    "},{"location":"generated/proposalManagement.vo-dml/#authors","title":"Authors","text":"

    Paul Harrison

    "},{"location":"generated/proposalManagement.vo-dml/#overview-diagram","title":"Overview diagram","text":"

    The whole model is represented in a model diagram below

    GVmapproposalManagement data modelproposal:ObservingMode proposal:ObservingMode proposal:Observatory proposal:Observatory proposal:Person proposal:Person proposal:ObservingProposal proposal:ObservingProposal proposalManagement:TacRole <<enumeration>> TacRole +TechnicalReviewer +ScienceReviewer +Chair proposalManagement:OfferedCycles OfferedCycles proposalManagement:ProposalCycle ProposalCycle +title : ivoa:string +submissionDeadline : ivoa:datetime +observationSessionStart : ivoa:datetime +observationSessionEnd : ivoa:datetime proposalManagement:OfferedCycles->proposalManagement:ProposalCyclecycles1..*proposalManagement:ProposalCycle->proposal:ObservingModeobservingModes1..*proposalManagement:ProposalCycle->proposal:Observatoryobservatory1proposalManagement:TAC TAC proposalManagement:ProposalCycle->proposalManagement:TACtac1proposalManagement:SubmittedProposal SubmittedProposal +submissionDate : ivoa:datetime proposalManagement:ProposalCycle->proposalManagement:SubmittedProposalsubmittedProposals0..*proposalManagement:ReviewedProposal ReviewedProposal +successful : ivoa:boolean +reviewsCompleteDate : ivoa:datetime proposalManagement:ProposalCycle->proposalManagement:ReviewedProposalreviewedProposals0..*proposalManagement:AllocatedProposal AllocatedProposal proposalManagement:ProposalCycle->proposalManagement:AllocatedProposalallocatedProposals0..*proposalManagement:AvailableResources AvailableResources proposalManagement:ProposalCycle->proposalManagement:AvailableResourcesavailableResources1proposalManagement:AllocationGrade AllocationGrade +name : ivoa:string +description : ivoa:string proposalManagement:ProposalCycle->proposalManagement:AllocationGradepossibleGrades1..*proposalManagement:Reviewer Reviewer proposalManagement:Reviewer->proposal:Personperson1proposalManagement:CommitteeMember CommitteeMember +role : proposalManagement:TacRole proposalManagement:CommitteeMember->proposalManagement:Reviewermember1proposalManagement:TAC->proposalManagement:CommitteeMembermembers1..*proposalManagement:SubmittedProposal->proposal:ObservingProposalproposal1proposalManagement:ReviewedProposal->proposalManagement:SubmittedProposalsubmitted1proposalManagement:ProposalReview ProposalReview +comment : ivoa:string +score : ivoa:real +technicalFeasibility : ivoa:boolean +reviewDate : ivoa:datetime proposalManagement:ReviewedProposal->proposalManagement:ProposalReviewreviews1..*proposalManagement:AllocatedProposal->proposalManagement:SubmittedProposalsubmitted1proposalManagement:AllocatedBlock AllocatedBlock proposalManagement:AllocatedProposal->proposalManagement:AllocatedBlockallocation1..*proposalManagement:ProposalReview->proposalManagement:Reviewerreviewer1proposalManagement:ResourceType ResourceType +name : ivoa:string +unit : ivoa:string proposalManagement:Resource Resource +amount : ivoa:real proposalManagement:Resource->proposalManagement:ResourceTypetype1proposalManagement:AvailableResources->proposalManagement:Resourceresources0..*proposalManagement:ResourceBlock ResourceBlock proposalManagement:ResourceBlock->proposal:ObservingModemode1proposalManagement:ResourceBlock->proposalManagement:Resourceresource1proposalManagement:AllocatedBlock->proposalManagement:AllocationGradegrade1proposalManagement:AllocatedBlock->proposalManagement:ResourceBlock"},{"location":"generated/proposalManagement.vo-dml/#enums","title":"Enums","text":"
    • TacRole
    "},{"location":"generated/proposalManagement.vo-dml/#objecttypes","title":"ObjectTypes","text":"
    • AllocatedBlock
    • AllocatedProposal
    • AllocationGrade
    • AvailableResources
    • CommitteeMember
    • OfferedCycles
    • ProposalCycle
    • ProposalReview
    • Resource
    • ResourceBlock
    • ResourceType
    • ReviewedProposal
    • Reviewer
    • SubmittedProposal
    • TAC
    "},{"location":"generated/proposalManagement.vo-dml/#imports","title":"Imports","text":"

    • ivoa

    • coords

    • proposal

    "},{"location":"generated/proposaldm.vo-dml/","title":"proposal","text":"

    version 0.3 2023-12-01

    "},{"location":"generated/proposaldm.vo-dml/#introduction","title":"Introduction","text":"

    A model to represent an application for observing time. The model is intended to express all of the concepts required to specify the scientific parameters of the application in sufficient detail to allow the proposal to be reviewed and allocated time. It does not cover all the technical detail of instrument setup that would be needed to actually schedule the observations, although the intention is that information about targets etc. could be automatically transferred to an observing system.

    "},{"location":"generated/proposaldm.vo-dml/#authors","title":"Authors","text":"

    Paul Harrison

    "},{"location":"generated/proposaldm.vo-dml/#overview-diagram","title":"Overview diagram","text":"

    The whole model is represented in a model diagram below

    GVmapproposal data modelproposal:WikiDataId <<primitive type>> WikiDataId proposal:ProposalKind <<enumeration>> ProposalKind +Standard +ToO +Survey proposal:InvestigatorKind <<enumeration>> InvestigatorKind +PI +COI proposal:InstrumentKind <<enumeration>> InstrumentKind +continuum +spectroscopic proposal:TextFormats <<enumeration>> TextFormats +latex +rst +asciidoc proposal:CalibrationTarget_intendedUse <<enumeration>> CalibrationTarget_intendedUse +Amplitude +Atmospheric +Bandpass +Phase +Pointing +Focus +Polarization +Delay proposal:ObservingProposal ObservingProposal +title : ivoa:string +summary : ivoa:string +kind : proposal:ProposalKind +submitted : ivoa:boolean proposal:RelatedProposal RelatedProposal proposal:ObservingProposal->proposal:RelatedProposalrelatedProposals0..*proposal:Investigator Investigator +type : proposal:InvestigatorKind +forPhD : ivoa:boolean proposal:ObservingProposal->proposal:Investigatorinvestigators1..*proposal:Justification Justification +text : ivoa:string +format : proposal:TextFormats proposal:ObservingProposal->proposal:JustificationscientificJustification1proposal:ObservingProposal->proposal:JustificationtechnicalJustification1proposal:SupportingDocument SupportingDocument +title : ivoa:string +location : ivoa:anyURI proposal:ObservingProposal->proposal:SupportingDocumentsupportingDocuments0..*proposal:Target Target +sourceName : ivoa:string proposal:ObservingProposal->proposal:Targettargets1..*proposal:Field Field +name : ivoa:string proposal:ObservingProposal->proposal:Fieldfields1..*proposal:Observation Observation proposal:ObservingProposal->proposal:Observationobservations1..*proposal:TechnicalGoal TechnicalGoal proposal:ObservingProposal->proposal:TechnicalGoaltechnicalGoals1..*proposal:RelatedProposal->proposal:ObservingProposalproposal1proposal:Person Person +fullName : ivoa:string +eMail : ivoa:string +orcidId : ivoa:stringIdentifier proposal:Organization Organization +name : ivoa:string +address : ivoa:string +ivoid : ivoa:ivorn +wikiId : proposal:WikiDataId proposal:Person->proposal:OrganizationhomeInstitute1proposal:Investigator->proposal:Personperson1proposal:Observatory Observatory proposal:Observatory->proposal:Organizationproposal:Telescope Telescope +name : ivoa:string +wikiId : proposal:WikiDataId +location : coords:GeocentricPoint proposal:Observatory->proposal:Telescopetelescopes1..*proposal:TelescopeArray TelescopeArray +name : ivoa:string proposal:Observatory->proposal:TelescopeArrayarrays0..*proposal:Instrument Instrument +name : ivoa:string +description : ivoa:string +wikiId : proposal:WikiDataId +reference : ivoa:anyURI +kind : proposal:InstrumentKind proposal:Observatory->proposal:Instrumentinstruments1..*proposal:Backend Backend +name : ivoa:string +parallel : ivoa:boolean proposal:Observatory->proposal:Backendbackends1..*proposal:TelescopeArrayMember TelescopeArrayMember proposal:TelescopeArrayMember->proposal:Telescopetelescope1proposal:TelescopeArray->proposal:TelescopeArrayMemberarrayMembers1..*proposal:SpectralWindowSetup SpectralWindowSetup +start : ivoa:RealQuantity +end : ivoa:RealQuantity +spectralResolution : ivoa:RealQuantity +isSkyFrequency : ivoa:boolean +polarization : coords:PolStateEnum proposal:Instrument->proposal:SpectralWindowSetupfrequencyCoverage1proposal:ObservingConfiguration ObservingConfiguration proposal:ObservingConfiguration->proposal:Telescopetelescope1proposal:ObservingConfiguration->proposal:Instrumentinstrument1proposal:ObservingConfiguration->proposal:Backendbackend1proposal:ObservingMode ObservingMode +name : ivoa:string +description : ivoa:string proposal:ObservingMode->proposal:ObservingConfigurationconfigurations1..*proposal:CelestialTarget CelestialTarget +sourceCoordinates : coords:EquatorialPoint +positionEpoch : coords:Epoch +pmRA : ivoa:RealQuantity +pmDec : ivoa:RealQuantity +parallax : ivoa:RealQuantity +sourceVelocity : ivoa:RealQuantity proposal:CelestialTarget->proposal:Targetproposal:SolarSystemTarget SolarSystemTarget proposal:SolarSystemTarget->proposal:Targetproposal:TargetField TargetField proposal:TargetField->proposal:Fieldproposal:Point Point +centre : coords:Point proposal:Point->proposal:Fieldproposal:Polygon Polygon +points : coords:EquatorialPoint proposal:Polygon->proposal:Fieldproposal:Ellipse Ellipse +semiMajor : ivoa:RealQuantity +semiMinor : ivoa:RealQuantity +pAMajor : ivoa:RealQuantity proposal:Ellipse->proposal:Fieldproposal:ObservingConstraint ObservingConstraint proposal:TimingConstraint TimingConstraint +note : ivoa:string +isAvoidConstraint : ivoa:boolean proposal:TimingConstraint->proposal:ObservingConstraintproposal:TimingWindow TimingWindow +startTime : ivoa:datetime +endTime : ivoa:datetime proposal:TimingWindow->proposal:TimingConstraintproposal:SimultaneityConstraint SimultaneityConstraint proposal:SimultaneityConstraint->proposal:TimingConstraintproposal:PointingConstaint PointingConstaint proposal:PointingConstaint->proposal:ObservingConstraintproposal:ScienceSpectralWindow ScienceSpectralWindow proposal:ScienceSpectralWindow->proposal:SpectralWindowSetupspectralWindowSetup0..1proposal:ExpectedSpectralLine ExpectedSpectralLine +restFrequency : ivoa:RealQuantity +transition : ivoa:string +splatalogId : ivoa:stringIdentifier +description : ivoa:string proposal:ScienceSpectralWindow->proposal:ExpectedSpectralLineexpectedSpectralLine0..*proposal:PerformanceParameters PerformanceParameters +desiredAngularResolution : ivoa:RealQuantity +desiredLargestScale : ivoa:RealQuantity +desiredSensitivity : ivoa:RealQuantity +desiredDynamicRange : ivoa:RealQuantity +representativeSpectralPoint : ivoa:RealQuantity proposal:Observation->proposal:Targettarget1proposal:Observation->proposal:Fieldfield1proposal:Observation->proposal:ObservingConstraintconstraints0..*proposal:Observation->proposal:TechnicalGoaltechnicalGoal1proposal:TargetObservation TargetObservation proposal:TargetObservation->proposal:Observationproposal:CalibrationObservation CalibrationObservation +intent : proposal:CalibrationTarget_intendedUse proposal:CalibrationObservation->proposal:Observationproposal:TechnicalGoal->proposal:ScienceSpectralWindowspectrum1..*proposal:TechnicalGoal->proposal:PerformanceParametersperformance1"},{"location":"generated/proposaldm.vo-dml/#primitives","title":"Primitives","text":"
    • WikiDataId
    "},{"location":"generated/proposaldm.vo-dml/#enums","title":"Enums","text":"
    • CalibrationTarget_intendedUse
    • InstrumentKind
    • InvestigatorKind
    • ProposalKind
    • TextFormats
    "},{"location":"generated/proposaldm.vo-dml/#objecttypes","title":"ObjectTypes","text":"
    • Backend
    • CalibrationObservation
    • CelestialTarget
    • Ellipse
    • ExpectedSpectralLine
    • Field
    • Instrument
    • Investigator
    • Justification
    • Observation
    • Observatory
    • ObservingConfiguration
    • ObservingConstraint
    • ObservingMode
    • ObservingProposal
    • Organization
    • PerformanceParameters
    • Person
    • Point
    • PointingConstaint
    • Polygon
    • RelatedProposal
    • ScienceSpectralWindow
    • SimultaneityConstraint
    • SolarSystemTarget
    • SpectralWindowSetup
    • SupportingDocument
    • Target
    • TargetField
    • TargetObservation
    • TechnicalGoal
    • Telescope
    • TelescopeArray
    • TelescopeArrayMember
    • TimingConstraint
    • TimingWindow
    "},{"location":"generated/proposaldm.vo-dml/#imports","title":"Imports","text":"

    • ivoa

    • coords

    "},{"location":"generated/coords/AstroCoordSystem/","title":"objectType AstroCoordSystem","text":"

    extends coords:CoordSys

    The AstroCoordSystem object holds a collection of component coordinate system descriptions across all represented physical domains.

    classDiagram\n\n        class AstroCoordSystem{\n\n        }\n        AstroCoordSystem --|> CoordSys\nAstroCoordSystem *-- PhysicalCoordSys : coordSys\n\n\n
    "},{"location":"generated/coords/AstroCoordSystem/#members","title":"Members","text":"name type mult description coordSys coords:PhysicalCoordSys 1 or more Coordinate system description for each physical domain (Space, Time, etc)."},{"location":"generated/coords/Axis/","title":"abstract objectType Axis","text":"

    The abstract parent class for all coordinate axis types. We provide concrete classes for the most common types of data, Continuous, Binned, and Discrete, but allow extension for other types as needed.

    classDiagram\n\n        class Axis{\n        ivoa:string name\n\n        }\n        ContinuousAxis --|> Axis\nBinnedAxis --|> Axis\nDiscreteSetAxis --|> Axis\n\n\n\n
    "},{"location":"generated/coords/Axis/#members","title":"Members","text":"name type mult description name ivoa:string optional Freeform string, provides the name or label for the axis."},{"location":"generated/coords/BinnedAxis/","title":"objectType BinnedAxis","text":"

    extends coords:Axis

    Axis description for binned data, where values along the axis correspond to a bin number.

    classDiagram\n\n        class BinnedAxis{\n        ivoa:nonnegativeInteger length\n\n        }\n        BinnedAxis --|> Axis\n\n
    "},{"location":"generated/coords/BinnedAxis/#members","title":"Members","text":"name type mult description length ivoa:nonnegativeInteger The length, or number of bins, along the axis."},{"location":"generated/coords/BinnedCoordinate/","title":"dataType BinnedCoordinate","text":"

    extends coords:Coordinate

    Coordinate value type specifically intended for binned data (e.g.: pixel indexes).

    classDiagram\n\n        class BinnedCoordinate{\n        ivoa:integer cval\n\n        }\n        BinnedCoordinate --|> Coordinate\nPixelIndex --|> BinnedCoordinate\n\n\n
    "},{"location":"generated/coords/BinnedCoordinate/#members","title":"Members","text":"name type mult description cval ivoa:integer The binned coordinate value, expressed as an integer. e.g.: bin number, pixel index."},{"location":"generated/coords/CartesianCoordSpace/","title":"objectType CartesianCoordSpace","text":"

    extends coords:PhysicalCoordSpace

    Spatial domain, three-dimensional cartesian coordinate space. The particulars of the axis descriptions depend on the physical constraints of the instance. In Appendix B, we provide the description of a Standard Cartesian Coordinate Space instance which applies to many Astronomical cases, and may be referenced in serializations.

    classDiagram\n\n        class CartesianCoordSpace{\n        coords:ContinuousAxis axis\n\n        }\n        CartesianCoordSpace --|> PhysicalCoordSpace\nPhysicalCoordSpace --|> CoordSpace\n\n\n
    "},{"location":"generated/coords/CartesianCoordSpace/#members","title":"Members","text":"name type mult description axis coords:ContinuousAxis subset"},{"location":"generated/coords/CartesianCoordSpace/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/CartesianCoordSpace/#axis","title":"axis","text":"

    Subsets axis in coords:CoordSpace from type coords:Axis to coords:ContinuousAxis

    "},{"location":"generated/coords/ContinuousAxis/","title":"objectType ContinuousAxis","text":"

    extends coords:Axis

    Axis description for continuous data. This object describes the domain for a particular axis of the domain space. It allows for the specification of the legal domain range (min,max), and a flag indicating if the axis is cyclic.

    classDiagram\n\n        class ContinuousAxis{\n        ivoa:Quantity domainMin\nivoa:Quantity domainMax\nivoa:boolean cyclic\n\n        }\n        ContinuousAxis --|> Axis\n\n
    "},{"location":"generated/coords/ContinuousAxis/#members","title":"Members","text":"name type mult description domainMin ivoa:Quantity optional Minimum extent of the axis domain space. If not provided, the domain space is considered to have no lower bound (-INFINITY). domainMax ivoa:Quantity optional Maximum extent of the axis domain space. If not provided, the domain space is considered to have no upper bound (+INFINITY). cyclic ivoa:boolean optional Flag indicating if the axis is cyclic in nature. If not provided, it is assumed to be FALSE."},{"location":"generated/coords/CoordFrame/","title":"abstract objectType CoordFrame","text":"

    This is the abstract, empty, base class for all coordinate frames. Coordinate frames provide metadata associated with the coordinate domain space. Typically, this will be related to the origin and orientation of the axes, but might include any metadata which pertains to the definition of the domain.

    classDiagram\n\n        class CoordFrame{\n\n        }\n        GenericFrame --|> CoordFrame\nSpaceFrame --|> CoordFrame\nTimeFrame --|> CoordFrame\n\n\n\n
    "},{"location":"generated/coords/CoordFrame/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/CoordSpace/","title":"abstract objectType CoordSpace","text":"

    This object defines a domain space. i.e.: it describes the set of possible coordinate values.

    classDiagram\n\n        class CoordSpace{\n\n        }\n        PixelSpace --|> CoordSpace\nPhysicalCoordSpace --|> CoordSpace\nCoordSpace *-- Axis : axis\n\n\n\n
    "},{"location":"generated/coords/CoordSpace/#members","title":"Members","text":"name type mult description axis coords:Axis 1 or more Describes an axis of the coordinate space."},{"location":"generated/coords/CoordSys/","title":"abstract objectType CoordSys","text":"

    Abstract head of the coordinate system object tree.

    classDiagram\n\n        class CoordSys{\n\n        }\n        AstroCoordSystem --|> CoordSys\nPixelCoordSystem --|> CoordSys\nPhysicalCoordSys --|> CoordSys\n\n\n\n
    "},{"location":"generated/coords/CoordSys/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/Coordinate/","title":"abstract dataType Coordinate","text":"

    Abstract base class for the Coordinate data types which represent an absolute location within a coordinate space. Coordinates MUST refer to a coordinate system, providing additional metadata relevant to interpreting the coordinate value, and its representation.

    classDiagram\n\n        class Coordinate{\n\n        }\n        BinnedCoordinate --|> Coordinate\nPhysicalCoordinate --|> Coordinate\nPoint --|> Coordinate\nSphericalPoint --|> Coordinate\nEquatorialPoint --|> Coordinate\nGeocentricPoint --|> Coordinate\nTimeStamp --|> Coordinate\nPolCoordinate --|> Coordinate\nCoordinate --> CoordSys : coordSys\n\n\n\n\n\n\n\n\n\n
    "},{"location":"generated/coords/Coordinate/#members","title":"Members","text":"name type mult description coordSys coords:CoordSys Provided additional metadata relevant to interpreting the coordinate value; for example, the spatial reference position, or time scale, axis descriptions."},{"location":"generated/coords/CustomRefLocation/","title":"dataType CustomRefLocation","text":"

    extends coords:RefLocation

    A custom reference location in phase space (position and velocity). Position and velocity are given as coordinates with an associated SpaceFrame. An epoch MAY be provided to further refine the location.

    classDiagram\n\n        class CustomRefLocation{\n        coords:Epoch epoch\ncoords:Point position\ncoords:Point velocity\n\n        }\n        CustomRefLocation --|> RefLocation\n\n
    "},{"location":"generated/coords/CustomRefLocation/#members","title":"Members","text":"name type mult description epoch coords:Epoch optional Epoch for the reference location. position coords:Point The spatial coordinates of the reference location. velocity coords:Point optional The velocity of the reference location."},{"location":"generated/coords/DiscreteSetAxis/","title":"objectType DiscreteSetAxis","text":"

    extends coords:Axis

    Axis type specifically intended for enumerated coordinates. Since the content and nature of this axis type is heavily dependent on the use case, we define no additional metadata here. Extensions of this type may include additional metadata relevant to the particular use cases. For example, an extension could include the allowed set of values.

    classDiagram\n\n        class DiscreteSetAxis{\n\n        }\n        DiscreteSetAxis --|> Axis\n\n
    "},{"location":"generated/coords/DiscreteSetAxis/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/Epoch/","title":"primitiveType Epoch","text":"

    We define epoch as a primitive data type with the expected form '$type$year' where type = 'J' or 'B' for Julian or Besselian respectively, and year is expressed as a decimal year. e.g.: 'B1950', 'J2000.0'

    "},{"location":"generated/coords/EquatorialPoint/","title":"dataType EquatorialPoint","text":"

    extends coords:Coordinate

    A Point on the Unit Sphere

    classDiagram\n\n        class EquatorialPoint{\n        coords:SpaceSys coordSys\nivoa:RealQuantity lon\nivoa:RealQuantity lat\n\n        }\n        EquatorialPoint --|> Coordinate\n\n
    "},{"location":"generated/coords/EquatorialPoint/#members","title":"Members","text":"name type mult description coordSys coords:SpaceSys subset lon ivoa:RealQuantity The longitudinal angle lat ivoa:RealQuantity The latitudinal angle"},{"location":"generated/coords/EquatorialPoint/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/EquatorialPoint/#coordsys","title":"coordSys","text":"

    Subsets coordSys in coords:Coordinate from type coords:CoordSys to coords:SpaceSys

    "},{"location":"generated/coords/GenericCoordSpace/","title":"objectType GenericCoordSpace","text":"

    extends coords:PhysicalCoordSpace

    Generic, one-dimensional coordinate space suitable for use with most non-spatial properties. In Appendix B, we provide the description of a Standard 1D Coordinate Space instance which may be referenced in serializations.

    classDiagram\n\n        class GenericCoordSpace{\n\n        }\n        GenericCoordSpace --|> PhysicalCoordSpace\nPhysicalCoordSpace --|> CoordSpace\n\n\n
    "},{"location":"generated/coords/GenericCoordSpace/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/GenericFrame/","title":"objectType GenericFrame","text":"

    extends coords:CoordFrame

    The generic coordinate frame is for cases where a domain-specific frame (e.g.: Space, Time), is not required, but the relevant reference metadata is still needed (e.g.: for Redshift or Spectral data)

    classDiagram\n\n        class GenericFrame{\n        coords:RefLocation refPosition\nivoa:string planetaryEphem\n\n        }\n        GenericFrame --|> CoordFrame\n\n
    "},{"location":"generated/coords/GenericFrame/#members","title":"Members","text":"name type mult description refPosition coords:RefLocation Spatial location in phase space (position and velocity) at which the observed value is considered to have been taken. This will typically be given by a standard reference position, but we allow for custom locations as well. planetaryEphem ivoa:string optional A planetary ephemeris MAY be provided, and SHOULD be provided whenever appropriate, to indicate which solar system ephemeris was used. If needed, but not provided, it is assumed to be 'DE405'"},{"location":"generated/coords/GenericSys/","title":"objectType GenericSys","text":"

    extends coords:PhysicalCoordSys

    Specialized coordinate system for generic, one-dimensional domains not covered by other, more concrete objects. If a CoordSpace is not provided, it is assumed to be represented by a Standard 1-Dimensional Coordinate Space as described in Appendix B.

    classDiagram\n\n        class GenericSys{\n        coords:GenericFrame frame\n\n        }\n        GenericSys --|> PhysicalCoordSys\nPhysicalCoordSys --|> CoordSys\n\n\n
    "},{"location":"generated/coords/GenericSys/#members","title":"Members","text":"name type mult description frame coords:GenericFrame subset"},{"location":"generated/coords/GenericSys/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/GenericSys/#frame","title":"frame","text":"

    Subsets frame in coords:PhysicalCoordSys from type coords:CoordFrame to coords:GenericFrame

    "},{"location":"generated/coords/GeocentricPoint/","title":"dataType GeocentricPoint","text":"

    extends coords:Coordinate

    ITRS earth coordinate

    classDiagram\n\n        class GeocentricPoint{\n        coords:SpaceSys coordSys\nivoa:RealQuantity x\nivoa:RealQuantity y\nivoa:RealQuantity z\n\n        }\n        GeocentricPoint --|> Coordinate\n\n
    "},{"location":"generated/coords/GeocentricPoint/#members","title":"Members","text":"name type mult description coordSys coords:SpaceSys subset x ivoa:RealQuantity cartesian x y ivoa:RealQuantity catesian y (+ve in east) z ivoa:RealQuantity cartesian z"},{"location":"generated/coords/GeocentricPoint/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/GeocentricPoint/#coordsys","title":"coordSys","text":"

    Subsets coordSys in coords:Coordinate from type coords:CoordSys to coords:SpaceSys

    "},{"location":"generated/coords/Handedness/","title":"enumeration Handedness","text":"

    The handedness of a coordinate space. For most cases, this will be a fixed value in the specification of the coordinate space. We provide this element to allow this flexibility when needed. In this document, it is used in the Pixel domain.

    classDiagram\n\n        class Handedness{\n           <<enumeration>>\nleft\nright\n\n        }\n
    "},{"location":"generated/coords/Handedness/#values","title":"Values","text":"

    • left - positive x and y axes point right and up, the positive z axis points inward

    • right - positive x and y axes point right and up, the positive z axis points outward

    "},{"location":"generated/coords/ISOTime/","title":"dataType ISOTime","text":"

    extends coords:TimeInstant

    Extension of TimeInstant for time expressed as a structured datetime string. The string representation of a datetime value should follow the FITS convention for representing dates (Hanish and Farris et al, 2001). The FITS standard is effectively ISO8601 format without the 'Z' tag to indicate UTC: YYYY-MM-DD['T'hh:mm:ss[.SSS]]. The TimeScale is provided in the associated TimeFrame.

    classDiagram\n\n        class ISOTime{\n        ivoa:datetime date\n\n        }\n        ISOTime --|> TimeInstant\nTimeInstant --|> TimeStamp\nTimeStamp --|> Coordinate\n\n\n\n
    "},{"location":"generated/coords/ISOTime/#members","title":"Members","text":"name type mult description date ivoa:datetime The ISOTime coordinate value."},{"location":"generated/coords/JD/","title":"dataType JD","text":"

    extends coords:TimeInstant

    Extension of TimeInstant for time expressed in Julian days. Note that JD does not properly specify a time stamp unless it is related to a time scale and reference position. Precision can easily become an issue with JD, as the numbers tend to be large.

    classDiagram\n\n        class JD{\n        ivoa:real date\n\n        }\n        JD --|> TimeInstant\nTimeInstant --|> TimeStamp\nTimeStamp --|> Coordinate\n\n\n\n
    "},{"location":"generated/coords/JD/#members","title":"Members","text":"name type mult description date ivoa:real The JD coordinate value. JD dates are dimensionless, with implied units in days."},{"location":"generated/coords/MJD/","title":"dataType MJD","text":"

    extends coords:TimeInstant

    Extension of TimeInstant for time expressed in Modified Julian Days. T(MJD) = T(JD) - 2400000.5.

    classDiagram\n\n        class MJD{\n        ivoa:real date\n\n        }\n        MJD --|> TimeInstant\nTimeInstant --|> TimeStamp\nTimeStamp --|> Coordinate\n\n\n\n
    "},{"location":"generated/coords/MJD/#members","title":"Members","text":"name type mult description date ivoa:real The MJD coordinate value. MJD dates are dimensionless, with implied units in days."},{"location":"generated/coords/PhysicalCoordSpace/","title":"abstract objectType PhysicalCoordSpace","text":"

    extends coords:CoordSpace

    Abstract head of coordinate spaces related to physical properties.

    classDiagram\n\n        class PhysicalCoordSpace{\n\n        }\n        PhysicalCoordSpace --|> CoordSpace\nGenericCoordSpace --|> PhysicalCoordSpace\nSphericalCoordSpace --|> PhysicalCoordSpace\nCartesianCoordSpace --|> PhysicalCoordSpace\n\n\n\n\n
    "},{"location":"generated/coords/PhysicalCoordSpace/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/PhysicalCoordSys/","title":"abstract objectType PhysicalCoordSys","text":"

    extends coords:CoordSys

    Coordinate system description for any physical domain, such as Time, Space, Redshift, Temperature, Flux, etc.

    classDiagram\n\n        class PhysicalCoordSys{\n\n        }\n        PhysicalCoordSys --|> CoordSys\nGenericSys --|> PhysicalCoordSys\nSpaceSys --|> PhysicalCoordSys\nTimeSys --|> PhysicalCoordSys\nPhysicalCoordSys *-- PhysicalCoordSpace : coordSpace\nPhysicalCoordSys *-- CoordFrame : frame\n\n\n\n\n\n\n
    "},{"location":"generated/coords/PhysicalCoordSys/#members","title":"Members","text":"name type mult description coordSpace coords:PhysicalCoordSpace optional Description of the coordinate space occupied by the property. frame coords:CoordFrame optional"},{"location":"generated/coords/PhysicalCoordinate/","title":"dataType PhysicalCoordinate","text":"

    extends coords:Coordinate

    The most common type of coordinate value. This type is appropriate for any data whose values can be described by an ivoa:Quantity (numeric, with unit).

    classDiagram\n\n        class PhysicalCoordinate{\n        ivoa:Quantity cval\n\n        }\n        PhysicalCoordinate --|> Coordinate\n\n
    "},{"location":"generated/coords/PhysicalCoordinate/#members","title":"Members","text":"name type mult description cval ivoa:Quantity This coordinate MUST contain a value expressed as an ivoa:Quantity."},{"location":"generated/coords/PixelCoordSystem/","title":"objectType PixelCoordSystem","text":"

    extends coords:CoordSys

    The PixelCoordSystem provides a complete description of the pixel coordinate space. It SHALL contain one PixelSpace instance describing each pixel axis.

    classDiagram\n\n        class PixelCoordSystem{\n\n        }\n        PixelCoordSystem --|> CoordSys\nPixelCoordSystem *-- PixelSpace : pixelSpace\n\n\n
    "},{"location":"generated/coords/PixelCoordSystem/#members","title":"Members","text":"name type mult description pixelSpace coords:PixelSpace The pixel space completely defines the pixel coordinate axes. Each axis MUST be defined as a BinnedAxis type."},{"location":"generated/coords/PixelIndex/","title":"dataType PixelIndex","text":"

    extends coords:BinnedCoordinate

    Specialized BinnedCoordinate for the pixel domain for a 1-dimensional pixel index. PixelIndex MUST refer to a PixelCoordSystem.

    classDiagram\n\n        class PixelIndex{\n\n        }\n        PixelIndex --|> BinnedCoordinate\nBinnedCoordinate --|> Coordinate\n\n\n
    "},{"location":"generated/coords/PixelIndex/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/PixelSpace/","title":"objectType PixelSpace","text":"

    extends coords:CoordSpace

    A PixelSpace SHALL include one or more BinnedAxis objects describing the pixel coordinate space. A handedness value MAY be provided to specify the relative orientation of the axes. 

    classDiagram\n\n        class PixelSpace{\n        coords:BinnedAxis axis\ncoords:Handedness handedness\n\n        }\n        PixelSpace --|> CoordSpace\n\n
    "},{"location":"generated/coords/PixelSpace/#members","title":"Members","text":"name type mult description axis coords:BinnedAxis subset handedness coords:Handedness optional Specifies the handedness of the coordinate space."},{"location":"generated/coords/PixelSpace/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/PixelSpace/#axis","title":"axis","text":"

    Subsets axis in coords:CoordSpace from type coords:Axis to coords:BinnedAxis

    "},{"location":"generated/coords/Point/","title":"dataType Point","text":"

    extends coords:Coordinate

    Multi-dimensional spatial coordinate. The Point MUST refer to a spatial coordinate system (SpaceSys). The coordinate values map, in order, to the axes described by the associated CoordSpace. Values for unused/undefined dimensions need not be provided.

    classDiagram\n\n        class Point{\n        coords:SpaceSys coordSys\nivoa:Quantity axis1\nivoa:Quantity axis2\nivoa:Quantity axis3\n\n        }\n        Point --|> Coordinate\n\n
    "},{"location":"generated/coords/Point/#members","title":"Members","text":"name type mult description coordSys coords:SpaceSys subset axis1 ivoa:Quantity optional Coordinate value along the first axis of the associated coordinate space, expressed as an ivoa:Quantity. axis2 ivoa:Quantity optional Coordinate value along the second axis of the associated coordinate space, expressed as an ivoa:Quantity. axis3 ivoa:Quantity optional Coordinate value along the third axis of the associated coordinate space, expressed as an ivoa:Quantity."},{"location":"generated/coords/Point/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/Point/#coordsys","title":"coordSys","text":"

    Subsets coordSys in coords:Coordinate from type coords:CoordSys to coords:SpaceSys

    "},{"location":"generated/coords/PolCoordinate/","title":"abstract dataType PolCoordinate","text":"

    extends coords:Coordinate

    Abstract head of the polarization coordinate types. Current use cases only require support for discrete polarization states, however, we include this head class to facilitate extension for other types (eg: polarization fraction and angle).

    classDiagram\n\n        class PolCoordinate{\n\n        }\n        PolCoordinate --|> Coordinate\nPolState --|> PolCoordinate\n\n\n
    "},{"location":"generated/coords/PolCoordinate/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/PolState/","title":"dataType PolState","text":"

    extends coords:PolCoordinate

    Coordinate type for discrete polarization states.

    classDiagram\n\n        class PolState{\n        coords:PolStateEnum cval\n\n        }\n        PolState --|> PolCoordinate\nPolCoordinate --|> Coordinate\n\n\n
    "},{"location":"generated/coords/PolState/#members","title":"Members","text":"name type mult description cval coords:PolStateEnum The coordinate value MUST be from the PolStateEnum enumerated set."},{"location":"generated/coords/PolStateEnum/","title":"enumeration PolStateEnum","text":"

    Polarization states: Stokes, Circular, Linear and Vector states

    classDiagram\n\n        class PolStateEnum{\n           <<enumeration>>\nI\nQ\nU\nV\nRR\nLL\nRL\nLR\nXX\nYY\nXY\nYX\nPF\nPP\nPA\n\n        }\n
    "},{"location":"generated/coords/PolStateEnum/#values","title":"Values","text":"

    • I -

    • Q -

    • U -

    • V -

    • RR -

    • LL -

    • RL -

    • LR -

    • XX -

    • YY -

    • XY -

    • YX -

    • PF -

    • PP -

    • PA -

    "},{"location":"generated/coords/RefLocation/","title":"abstract dataType RefLocation","text":"

    RefLocation defines the origin of the spatial coordinate space. This location is represented either by a standard reference position (for which the absolute location in phase space is known by definition), or a specified point in another Spatial frame. This object is used as the origin of the SpaceFrame here, but also to specify the Spatial Reference Position (refPosition) associated with other domain Frames. For example, in the Time domain, the Spatial Reference Position indicates that the 'time' values are the time that the 'event' occured at that location, which might be different from the detector location. 

    classDiagram\n\n        class RefLocation{\n\n        }\n        StdRefLocation --|> RefLocation\nCustomRefLocation --|> RefLocation\n\n\n
    "},{"location":"generated/coords/RefLocation/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/SpaceFrame/","title":"objectType SpaceFrame","text":"

    extends coords:CoordFrame

    A SpaceFrame is specified by its reference frame (orientation), and a reference position (origin). Currently only standard reference frames are allowed. An equinox MUST be provided for pre-ICRS reference frames. A planetary ephemeris MAY be provided if relevant. If needed, but not provided, it is assumed to be 'DE405'.

    classDiagram\n\n        class SpaceFrame{\n        coords:RefLocation refPosition\nivoa:string spaceRefFrame\ncoords:Epoch equinox\nivoa:string planetaryEphem\n\n        }\n        SpaceFrame --|> CoordFrame\n\n
    "},{"location":"generated/coords/SpaceFrame/#members","title":"Members","text":"name type mult description refPosition coords:RefLocation The spatial location at which the coordinates are considered to have been determined. This model supports locations provided as either a standard reference position (e.g. GEOCENTER), or a coordinate specifying a custom location (e.g. long, lat, height ). spaceRefFrame ivoa:string The spatial reference frame. Values MUST be selected from the controlled vocabulary at the given URL. equinox coords:Epoch optional Reference date for the frame, required for pre-ICRS reference frames. planetaryEphem ivoa:string optional Ephemeris file for solar system objects SHOULD be specified whenever relevant."},{"location":"generated/coords/SpaceSys/","title":"objectType SpaceSys","text":"

    extends coords:PhysicalCoordSys

    Specialized coordinate system for the Spatial domain. This object SHOULD include an appropriate SpaceFrame. In Appendix B, we define two standard spatial coordinate space instances (Spherical and Cartesian), which may be referenced in serializations. If a CoordSpace is not provided, it is assumed to be represented by a Standard Spherical Coordinate Space.

    classDiagram\n\n        class SpaceSys{\n        coords:SpaceFrame frame\n\n        }\n        SpaceSys --|> PhysicalCoordSys\nPhysicalCoordSys --|> CoordSys\n\n\n
    "},{"location":"generated/coords/SpaceSys/#members","title":"Members","text":"name type mult description frame coords:SpaceFrame subset"},{"location":"generated/coords/SpaceSys/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/SpaceSys/#frame","title":"frame","text":"

    Subsets frame in coords:PhysicalCoordSys from type coords:CoordFrame to coords:SpaceFrame

    "},{"location":"generated/coords/SphericalCoordSpace/","title":"objectType SphericalCoordSpace","text":"

    extends coords:PhysicalCoordSpace

    Spatial domain, three-dimensional spherical coordinate space. The particulars of the axis descriptions depend on the flavor of space being instantiated. In Appendix B., we provide a Standard Spherical Coordinate Space instance which applies to many Astronomical use cases. It provides the default space for SpaceSys instances, and may be referenced in serializations.

    classDiagram\n\n        class SphericalCoordSpace{\n        coords:ContinuousAxis axis\n\n        }\n        SphericalCoordSpace --|> PhysicalCoordSpace\nPhysicalCoordSpace --|> CoordSpace\n\n\n
    "},{"location":"generated/coords/SphericalCoordSpace/#members","title":"Members","text":"name type mult description axis coords:ContinuousAxis subset"},{"location":"generated/coords/SphericalCoordSpace/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/SphericalCoordSpace/#axis","title":"axis","text":"

    Subsets axis in coords:CoordSpace from type coords:Axis to coords:ContinuousAxis

    "},{"location":"generated/coords/SphericalPoint/","title":"dataType SphericalPoint","text":"

    extends coords:Coordinate

    A point in space expressed in spherical coordinates

    classDiagram\n\n        class SphericalPoint{\n        coords:SpaceSys coordSys\nivoa:RealQuantity r\nivoa:RealQuantity theta\nivoa:RealQuantity phi\n\n        }\n        SphericalPoint --|> Coordinate\n\n
    "},{"location":"generated/coords/SphericalPoint/#members","title":"Members","text":"name type mult description coordSys coords:SpaceSys subset r ivoa:RealQuantity radius theta ivoa:RealQuantity polar angle phi ivoa:RealQuantity azimuthal angle"},{"location":"generated/coords/SphericalPoint/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/SphericalPoint/#coordsys","title":"coordSys","text":"

    Subsets coordSys in coords:Coordinate from type coords:CoordSys to coords:SpaceSys

    "},{"location":"generated/coords/StdRefLocation/","title":"dataType StdRefLocation","text":"

    extends coords:RefLocation

    An absolute a-priori known location in phase space (position and velocity). Values are selected from the StdRefPosition vocabulary. Considering that the GEOCENTER is really the only place for which we know the absolute location at all times, all other locations require the specification of a planetary ephemeris. LSR[KD] are reserved for spectral and reshift frames. TOPOCENTER (location of the observer) is special in that it assumes that the observing location is available through other means (e.g. a geographic location or an orbit ephemeris). RELOCATABLE is available for simulations. UNKNOWN should only be used if absolutely necessary.

    classDiagram\n\n        class StdRefLocation{\n        ivoa:string position\n\n        }\n        StdRefLocation --|> RefLocation\n\n
    "},{"location":"generated/coords/StdRefLocation/#members","title":"Members","text":"name type mult description position ivoa:string Standard reference location. Values MUST be selected from the controlled vocabulary at the given URL."},{"location":"generated/coords/TimeFrame/","title":"objectType TimeFrame","text":"

    extends coords:CoordFrame

    A TimeFrame SHALL include a time scale and reference position. It MAY also include a reference direction.

    classDiagram\n\n        class TimeFrame{\n        coords:RefLocation refPosition\nivoa:string timescale\ncoords:RefLocation refDirection\n\n        }\n        TimeFrame --|> CoordFrame\n\n
    "},{"location":"generated/coords/TimeFrame/#members","title":"Members","text":"name type mult description refPosition coords:RefLocation The spatial location at which the coordinate is considered to have been taken. This model supports locations provided as either a standard reference position (e.g. GEOCENTER), or a coordinate specifying a custom location (e.g. long, lat, height). timescale ivoa:string The time scale sets the reference frame. The value MUST be selected from the controlled vocabulary at the given URL. refDirection coords:RefLocation optional The reference direction is needed if the time stamps are transformed to a time frame with a different reference position. In those situations, the solar system ephemeris also comes into play. See: FITS WCS Paper IV for details, but in short: The reference direction, presumably the direction to the thing being observed, is used in conjunction with the reference position and planetary ephemeris to determine the correction applied for the path length change. To be fully useful, one also needs to know the location at which the observation was made ( i.e. the observatory location), which is not considered to be Frame metadata."},{"location":"generated/coords/TimeInstant/","title":"abstract dataType TimeInstant","text":"

    extends coords:TimeStamp

    TimeStamps which specify a specific instant in time. We define three subtypes (ISOTime, JD, MJD), which allow users to explicitly identify the representation and interpretation of the TimeInstant.

    classDiagram\n\n        class TimeInstant{\n\n        }\n        TimeInstant --|> TimeStamp\nTimeStamp --|> Coordinate\nJD --|> TimeInstant\nMJD --|> TimeInstant\nISOTime --|> TimeInstant\n\n\n\n\n\n
    "},{"location":"generated/coords/TimeInstant/#members","title":"Members","text":"name type mult description"},{"location":"generated/coords/TimeOffset/","title":"dataType TimeOffset","text":"

    extends coords:TimeStamp

    Time is given as an offset from a specific point in time (time0).

    classDiagram\n\n        class TimeOffset{\n        ivoa:RealQuantity time\ncoords:TimeInstant time0\n\n        }\n        TimeOffset --|> TimeStamp\nTimeStamp --|> Coordinate\n\n\n
    "},{"location":"generated/coords/TimeOffset/#members","title":"Members","text":"name type mult description time ivoa:RealQuantity The TimeOffset coordinate value. time0 coords:TimeInstant The reference time from which the offset is calculated. This MUST be given as a TimeInstant (e.g.: JD, MJD, ISOTime)."},{"location":"generated/coords/TimeStamp/","title":"abstract dataType TimeStamp","text":"

    extends coords:Coordinate

    This is the abstract basis for a set of simple time domain coordinates which are expected to accommodate the vast majority of use cases. All TimeStamps, by definition, exist in a standard 1-D coordinate space, with domainMin|Max of +/-Infinity. All TimeStamps MUST refer to an appropriate TimeSys.

    classDiagram\n\n        class TimeStamp{\n        coords:TimeSys coordSys\n\n        }\n        TimeStamp --|> Coordinate\nTimeOffset --|> TimeStamp\nTimeInstant --|> TimeStamp\n\n\n\n
    "},{"location":"generated/coords/TimeStamp/#members","title":"Members","text":"name type mult description coordSys coords:TimeSys subset"},{"location":"generated/coords/TimeStamp/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/TimeStamp/#coordsys","title":"coordSys","text":"

    Subsets coordSys in coords:Coordinate from type coords:CoordSys to coords:TimeSys

    "},{"location":"generated/coords/TimeSys/","title":"objectType TimeSys","text":"

    extends coords:PhysicalCoordSys

    Specialized coordinate system for the Temporal domain. This object SHOULD include an appropriate TimeFrame. If a CoordSpace is not provided, it is assumed to be represented by a Standard 1-Dimensional Coordinate Space as described in Appendix B.

    classDiagram\n\n        class TimeSys{\n        coords:TimeFrame frame\ncoords:GenericCoordSpace coordSpace\n\n        }\n        TimeSys --|> PhysicalCoordSys\nPhysicalCoordSys --|> CoordSys\n\n\n
    "},{"location":"generated/coords/TimeSys/#members","title":"Members","text":"name type mult description frame coords:TimeFrame subset coordSpace coords:GenericCoordSpace subset"},{"location":"generated/coords/TimeSys/#subset-detail","title":"Subset Detail","text":""},{"location":"generated/coords/TimeSys/#frame","title":"frame","text":"

    Subsets frame in coords:PhysicalCoordSys from type coords:CoordFrame to coords:TimeFrame

    "},{"location":"generated/coords/TimeSys/#coordspace","title":"coordSpace","text":"

    Subsets coordSpace in coords:PhysicalCoordSys from type coords:PhysicalCoordSpace to coords:GenericCoordSpace

    "},{"location":"generated/proposal/Backend/","title":"objectType Backend","text":"

    a processing backend /pipeline- e.g. correlator

    classDiagram\n\n        class Backend{\n        ivoa:string name\nivoa:boolean parallel\n\n        }\n
    "},{"location":"generated/proposal/Backend/#members","title":"Members","text":"name type mult description name ivoa:string the backend name parallel ivoa:boolean is capable of being run at same time as other backends"},{"location":"generated/proposal/CalibrationObservation/","title":"objectType CalibrationObservation","text":"

    extends Observation

    An observation that is intended for calibration

    classDiagram\n\n        class CalibrationObservation{\n        proposal:CalibrationTarget_intendedUse intent\n\n        }\n        CalibrationObservation --|> Observation\n\nlink Observation \"../Observation\"
    "},{"location":"generated/proposal/CalibrationObservation/#members","title":"Members","text":"name type mult description intent CalibrationTarget_intendedUse The use of the calibration observation"},{"location":"generated/proposal/CalibrationTarget_intendedUse/","title":"enumeration CalibrationTarget_intendedUse","text":"
    classDiagram\n\n        class CalibrationTarget_intendedUse{\n           <<enumeration>>\nAmplitude\nAtmospheric\nBandpass\nPhase\nPointing\nFocus\nPolarization\nDelay\n\n        }\n
    "},{"location":"generated/proposal/CalibrationTarget_intendedUse/#values","title":"Values","text":"

    • Amplitude -

    • Atmospheric - used to measure atmospheric effects

    • Bandpass -

    • Phase -

    • Pointing -

    • Focus -

    • Polarization -

    • Delay -

    "},{"location":"generated/proposal/CelestialTarget/","title":"objectType CelestialTarget","text":"

    extends Target

    The basic target setup for a celestial Target.

    classDiagram\n\n        class CelestialTarget{\n        coords:EquatorialPoint sourceCoordinates\ncoords:Epoch positionEpoch\nivoa:RealQuantity pmRA\nivoa:RealQuantity pmDec\nivoa:RealQuantity parallax\nivoa:RealQuantity sourceVelocity\n\n        }\n        CelestialTarget --|> Target\n\nlink Target \"../Target\"
    "},{"location":"generated/proposal/CelestialTarget/#members","title":"Members","text":"name type mult description sourceCoordinates coords:EquatorialPoint positionEpoch coords:Epoch the epoch at which the position was measured pmRA ivoa:RealQuantity optional pmDec ivoa:RealQuantity optional parallax ivoa:RealQuantity optional sourceVelocity ivoa:RealQuantity optional"},{"location":"generated/proposal/Constraint/","title":"abstract objectType Constraint","text":"

    a form of constraint on the observation

    classDiagram\n\n        class Constraint{\n\n        }\n        TimingConstraint --|> Constraint\nPointingConstaint --|> Constraint\n\nlink TimingConstraint \"../TimingConstraint\"\nlink PointingConstaint \"../PointingConstaint\"
    "},{"location":"generated/proposal/Constraint/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/Ellipse/","title":"objectType Ellipse","text":"

    extends Field

    Specialization of a Field for an elliptical map.

    classDiagram\n\n        class Ellipse{\n        ivoa:RealQuantity semiMajor\nivoa:RealQuantity semiMinor\nivoa:RealQuantity pAMajor\n\n        }\n        Ellipse --|> Field\n\nlink Field \"../Field\"
    "},{"location":"generated/proposal/Ellipse/#members","title":"Members","text":"name type mult description semiMajor ivoa:RealQuantity semiMinor ivoa:RealQuantity pAMajor ivoa:RealQuantity"},{"location":"generated/proposal/ExpectedSpectralLine/","title":"objectType ExpectedSpectralLine","text":"

    Brief description of a spectral line.

    classDiagram\n\n        class ExpectedSpectralLine{\n        ivoa:RealQuantity restFrequency\nivoa:string transition\nivoa:stringIdentifier splatalogId\nivoa:string description\n\n        }\n
    "},{"location":"generated/proposal/ExpectedSpectralLine/#members","title":"Members","text":"name type mult description restFrequency ivoa:RealQuantity transition ivoa:string optional splatalogId ivoa:stringIdentifier description ivoa:string"},{"location":"generated/proposal/Field/","title":"abstract objectType Field","text":"

    Definition of an observing field pointing

    classDiagram\n\n        class Field{\n        ivoa:string name\n\n        }\n        TargetField --|> Field\nPoint --|> Field\nPolygon --|> Field\nEllipse --|> Field\n\nlink TargetField \"../TargetField\"\nlink Point \"../Point\"\nlink Polygon \"../Polygon\"\nlink Ellipse \"../Ellipse\"
    "},{"location":"generated/proposal/Field/#members","title":"Members","text":"name type mult description name ivoa:string"},{"location":"generated/proposal/Instrument/","title":"objectType Instrument","text":"

    An instrument that can be attached to a telescope - e.g. CCD, Radio Receiver

    classDiagram\n\n        class Instrument{\n        ivoa:string name\nivoa:string description\nproposal:WikiDataId wikiId\nivoa:anyURI reference\nproposal:InstrumentKind kind\n\n        }\n        Instrument *-- SpectralWindowSetup : frequencyCoverage\n\nlink SpectralWindowSetup \"../SpectralWindowSetup\"
    "},{"location":"generated/proposal/Instrument/#members","title":"Members","text":"name type mult description name ivoa:string the instrument name - human readable description ivoa:string optional short human readable description wikiId WikiDataId optional the wikidata id for the Instrument reference ivoa:anyURI optional a URL that points to a more detailed description of the instrument kind InstrumentKind the kind of instrument frequencyCoverage SpectralWindowSetup the frequency range that the instrument covers"},{"location":"generated/proposal/InstrumentKind/","title":"enumeration InstrumentKind","text":"
    classDiagram\n\n        class InstrumentKind{\n           <<enumeration>>\ncontinuum\nspectroscopic\n\n        }\n
    "},{"location":"generated/proposal/InstrumentKind/#values","title":"Values","text":"

    • continuum -

    • spectroscopic -

    "},{"location":"generated/proposal/Investigator/","title":"objectType Investigator","text":"
    classDiagram\n\n        class Investigator{\n        proposal:InvestigatorKind type\nivoa:boolean forPhD\n\n        }\n        Investigator --> Person : person\n\nlink Person \"../Person\"
    "},{"location":"generated/proposal/Investigator/#members","title":"Members","text":"name type mult description type InvestigatorKind the investigator type forPhD ivoa:boolean optional is the investigator making proposal for their PhD person Person the investigator"},{"location":"generated/proposal/InvestigatorKind/","title":"enumeration InvestigatorKind","text":"
    classDiagram\n\n        class InvestigatorKind{\n           <<enumeration>>\nPI\nCOI\n\n        }\n
    "},{"location":"generated/proposal/InvestigatorKind/#values","title":"Values","text":"

    • PI - principal investigator

    • COI - co-investigator

    "},{"location":"generated/proposal/Justification/","title":"objectType Justification","text":"

    The justification for the proposal. Note that the justification is for reading by humans and is not parsed to extract things like source lists - that sort of information must be entered in the correct place in the model.

    classDiagram\n\n        class Justification{\n        ivoa:string text\nproposal:TextFormats format\n\n        }\n
    "},{"location":"generated/proposal/Justification/#members","title":"Members","text":"name type mult description text ivoa:string the full text of the justification format TextFormats the format of the text"},{"location":"generated/proposal/Observation/","title":"abstract objectType Observation","text":"
    classDiagram\n\n        class Observation{\n\n        }\n        TargetObservation --|> Observation\nCalibrationObservation --|> Observation\nObservation --> Target : target\nObservation --> Field : field\nObservation --> TechnicalGoal : technicalGoal\nObservation *-- ObservingConstraint : constraints\n\nlink TargetObservation \"../TargetObservation\"\nlink CalibrationObservation \"../CalibrationObservation\"\nlink Target \"../Target\"\nlink Field \"../Field\"\nlink TechnicalGoal \"../TechnicalGoal\"\nlink ObservingConstraint \"../ObservingConstraint\"
    "},{"location":"generated/proposal/Observation/#members","title":"Members","text":"name type mult description constraints ObservingConstraint 0 or more any constraints on the observation target Target The actual target of the observation field Field The Field for the observation technicalGoal TechnicalGoal The technical goals of the observation"},{"location":"generated/proposal/Observatory/","title":"objectType Observatory","text":"

    extends Organization

    An organisation that can perform astronomical observations

    classDiagram\n\n        class Observatory{\n\n        }\n        Observatory --|> Organization\nObservatory *-- Telescope : telescopes\nObservatory *-- Instrument : instruments\nObservatory *-- Backend : backends\nObservatory *-- TelescopeArray : arrays\n\nlink Organization \"../Organization\"\nlink Telescope \"../Telescope\"\nlink Instrument \"../Instrument\"\nlink Backend \"../Backend\"\nlink TelescopeArray \"../TelescopeArray\"
    "},{"location":"generated/proposal/Observatory/#members","title":"Members","text":"name type mult description telescopes Telescope 1 or more the telescopes that the observatory controls instruments Instrument 1 or more the instruments that are available for the telescopes backends Backend 1 or more the backends that exist arrays TelescopeArray 0 or more any arrays of telescopes that typically operate together"},{"location":"generated/proposal/ObservingConfiguration/","title":"objectType ObservingConfiguration","text":"

    A particular observation combination that is possible

    classDiagram\n\n        class ObservingConfiguration{\n\n        }\n        ObservingConfiguration --> Telescope : telescope\nObservingConfiguration --> Instrument : instrument\nObservingConfiguration --> Backend : backend\n\nlink Telescope \"../Telescope\"\nlink Instrument \"../Instrument\"\nlink Backend \"../Backend\"
    "},{"location":"generated/proposal/ObservingConfiguration/#members","title":"Members","text":"name type mult description telescope Telescope instrument Instrument backend Backend"},{"location":"generated/proposal/ObservingConstraint/","title":"abstract objectType ObservingConstraint","text":"

    a form of constraint on the observation

    classDiagram\n\n        class ObservingConstraint{\n\n        }\n        TimingConstraint --|> ObservingConstraint\nPointingConstaint --|> ObservingConstraint\n\nlink TimingConstraint \"../TimingConstraint\"\nlink PointingConstaint \"../PointingConstaint\"
    "},{"location":"generated/proposal/ObservingConstraint/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/ObservingMode/","title":"objectType ObservingMode","text":"

    a collection of configs that can be chosen to observe with.

    classDiagram\n\n        class ObservingMode{\n        ivoa:string name\nivoa:string description\n\n        }\n        ObservingMode *-- ObservingConfiguration : configurations\n\nlink ObservingConfiguration \"../ObservingConfiguration\"
    "},{"location":"generated/proposal/ObservingMode/#members","title":"Members","text":"name type mult description name ivoa:string description ivoa:string configurations ObservingConfiguration 1 or more"},{"location":"generated/proposal/ObservingProposal/","title":"objectType ObservingProposal","text":"

    a complete proposal

    classDiagram\n\n        class ObservingProposal{\n        ivoa:string title\nivoa:string summary\nproposal:ProposalKind kind\nivoa:boolean submitted\n\n        }\n        ObservingProposal *-- Justification : scientificJustification\nObservingProposal *-- Justification : technicalJustification\nObservingProposal *-- Investigator : investigators\nObservingProposal *-- RelatedProposal : relatedProposals\nObservingProposal *-- SupportingDocument : supportingDocuments\nObservingProposal *-- Target : targets\nObservingProposal *-- Field : fields\nObservingProposal *-- TechnicalGoal : technicalGoals\nObservingProposal *-- Observation : observations\n\nlink Justification \"../Justification\"\nlink Justification \"../Justification\"\nlink Investigator \"../Investigator\"\nlink RelatedProposal \"../RelatedProposal\"\nlink SupportingDocument \"../SupportingDocument\"\nlink Target \"../Target\"\nlink Field \"../Field\"\nlink TechnicalGoal \"../TechnicalGoal\"\nlink Observation \"../Observation\"
    "},{"location":"generated/proposal/ObservingProposal/#members","title":"Members","text":"name type mult description title ivoa:string the proposal title summary ivoa:string a short summary/abstract of the proposal kind ProposalKind the type of proposal submitted ivoa:boolean optional whether the proposal is submitted scientificJustification Justification scientific justification technicalJustification Justification technical justification investigators Investigator 1 or more the person(s) making the proposal relatedProposals RelatedProposal 0 or more supportingDocuments SupportingDocument 0 or more any additional documents targets Target 1 or more the targets of the proposal fields Field 1 or more the fields observed in the proposal technicalGoals TechnicalGoal 1 or more the technical goals of the proposal observations Observation 1 or more the proposed observations"},{"location":"generated/proposal/Organization/","title":"objectType Organization","text":"

    An institution that is a collection of people

    classDiagram\n\n        class Organization{\n        ivoa:string name\nivoa:string address\nivoa:ivorn ivoid\nproposal:WikiDataId wikiId\n\n        }\n        Observatory --|> Organization\n\nlink Observatory \"../Observatory\"
    "},{"location":"generated/proposal/Organization/#members","title":"Members","text":"name type mult description name ivoa:string The name of the organization address ivoa:string ivoid ivoa:ivorn optional the registry identifier for the organization wikiId WikiDataId optional the wikidata id for the Organization"},{"location":"generated/proposal/PerformanceParameters/","title":"objectType PerformanceParameters","text":"

    The parameters required for observation to be useful for the science goal

    classDiagram\n\n        class PerformanceParameters{\n        ivoa:RealQuantity desiredAngularResolution\nivoa:RealQuantity desiredLargestScale\nivoa:RealQuantity desiredSensitivity\nivoa:RealQuantity desiredDynamicRange\nivoa:RealQuantity representativeSpectralPoint\n\n        }\n
    "},{"location":"generated/proposal/PerformanceParameters/#members","title":"Members","text":"name type mult description desiredAngularResolution ivoa:RealQuantity optional desiredLargestScale ivoa:RealQuantity optional desiredSensitivity ivoa:RealQuantity optional desiredDynamicRange ivoa:RealQuantity optional representativeSpectralPoint ivoa:RealQuantity the the point in the EM where these parameters should be evaluated"},{"location":"generated/proposal/Person/","title":"objectType Person","text":"

    person connected with the proposal

    classDiagram\n\n        class Person{\n        ivoa:string fullName\nivoa:string eMail\nivoa:stringIdentifier orcidId\n\n        }\n        Person --> Organization : homeInstitute\n\nlink Organization \"../Organization\"
    "},{"location":"generated/proposal/Person/#members","title":"Members","text":"name type mult description fullName ivoa:string The given names for the person eMail ivoa:string an email that can be used to communicate with the person orcidId ivoa:stringIdentifier optional orcid id see https://orcid.org homeInstitute Organization"},{"location":"generated/proposal/Point/","title":"objectType Point","text":"

    extends Field

    Single point on the sky

    classDiagram\n\n        class Point{\n        coords:Point centre\n\n        }\n        Point --|> Field\n\nlink Field \"../Field\"
    "},{"location":"generated/proposal/Point/#members","title":"Members","text":"name type mult description centre coords:Point"},{"location":"generated/proposal/PointingConstaint/","title":"abstract objectType PointingConstaint","text":"

    extends ObservingConstraint

    A constraint that limits the telescope pointing

    classDiagram\n\n        class PointingConstaint{\n\n        }\n        PointingConstaint --|> ObservingConstraint\n\nlink ObservingConstraint \"../ObservingConstraint\"
    "},{"location":"generated/proposal/PointingConstaint/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/Polygon/","title":"objectType Polygon","text":"

    extends Field

    Polygonal map

    classDiagram\n\n        class Polygon{\n        coords:EquatorialPoint points\n\n        }\n        Polygon --|> Field\n\nlink Field \"../Field\"
    "},{"location":"generated/proposal/Polygon/#members","title":"Members","text":"name type mult description points coords:EquatorialPoint 0 or more an array of points...."},{"location":"generated/proposal/ProposalKind/","title":"enumeration ProposalKind","text":"
    classDiagram\n\n        class ProposalKind{\n           <<enumeration>>\nStandard\nToO\nSurvey\n\n        }\n
    "},{"location":"generated/proposal/ProposalKind/#values","title":"Values","text":"

    • Standard - Normal proposal

    • ToO - target of opportunity

    • Survey - Part of a large programme

    "},{"location":"generated/proposal/RelatedProposal/","title":"objectType RelatedProposal","text":"

    a related proposal

    classDiagram\n\n        class RelatedProposal{\n\n        }\n        RelatedProposal --> ObservingProposal : proposal\n\nlink ObservingProposal \"../ObservingProposal\"
    "},{"location":"generated/proposal/RelatedProposal/#members","title":"Members","text":"name type mult description proposal ObservingProposal the related proposal"},{"location":"generated/proposal/ScienceSpectralWindow/","title":"objectType ScienceSpectralWindow","text":"

    A spectral window for science use.

    classDiagram\n\n        class ScienceSpectralWindow{\n\n        }\n        ScienceSpectralWindow *-- SpectralWindowSetup : spectralWindowSetup\nScienceSpectralWindow *-- ExpectedSpectralLine : expectedSpectralLine\n\nlink SpectralWindowSetup \"../SpectralWindowSetup\"\nlink ExpectedSpectralLine \"../ExpectedSpectralLine\"
    "},{"location":"generated/proposal/ScienceSpectralWindow/#members","title":"Members","text":"name type mult description spectralWindowSetup SpectralWindowSetup optional expectedSpectralLine ExpectedSpectralLine 0 or more"},{"location":"generated/proposal/SimultaneityConstraint/","title":"objectType SimultaneityConstraint","text":"

    extends TimingConstraint

    A constraint that requires that two observations occur simultaneously

    classDiagram\n\n        class SimultaneityConstraint{\n\n        }\n        SimultaneityConstraint --|> TimingConstraint\nTimingConstraint --|> ObservingConstraint\n\nlink TimingConstraint \"../TimingConstraint\"\nlink ObservingConstraint \"../ObservingConstraint\"
    "},{"location":"generated/proposal/SimultaneityConstraint/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/SolarSystemTarget/","title":"objectType SolarSystemTarget","text":"

    extends Target

    classDiagram\n\n        class SolarSystemTarget{\n\n        }\n        SolarSystemTarget --|> Target\n\nlink Target \"../Target\"
    "},{"location":"generated/proposal/SolarSystemTarget/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/SpectralWindowSetup/","title":"objectType SpectralWindowSetup","text":"

    Science oriented definition of a spectral window.

    classDiagram\n\n        class SpectralWindowSetup{\n        ivoa:RealQuantity start\nivoa:RealQuantity end\nivoa:RealQuantity spectralResolution\nivoa:boolean isSkyFrequency\ncoords:PolStateEnum polarization\n\n        }\n
    "},{"location":"generated/proposal/SpectralWindowSetup/#members","title":"Members","text":"name type mult description start ivoa:RealQuantity The start of the spectral window end ivoa:RealQuantity The end of the spectral window spectralResolution ivoa:RealQuantity optional channel width isSkyFrequency ivoa:boolean represents an observed frequency polarization coords:PolStateEnum desired polarization"},{"location":"generated/proposal/SupportingDocument/","title":"objectType SupportingDocument","text":"

    a document

    classDiagram\n\n        class SupportingDocument{\n        ivoa:string title\nivoa:anyURI location\n\n        }\n
    "},{"location":"generated/proposal/SupportingDocument/#members","title":"Members","text":"name type mult description title ivoa:string document title location ivoa:anyURI location of document"},{"location":"generated/proposal/Target/","title":"abstract objectType Target","text":"

    A target source

    classDiagram\n\n        class Target{\n        ivoa:string sourceName\n\n        }\n        CelestialTarget --|> Target\nSolarSystemTarget --|> Target\n\nlink CelestialTarget \"../CelestialTarget\"\nlink SolarSystemTarget \"../SolarSystemTarget\"
    "},{"location":"generated/proposal/Target/#members","title":"Members","text":"name type mult description sourceName ivoa:string A common name for the source"},{"location":"generated/proposal/TargetField/","title":"objectType TargetField","text":"

    extends Field

    the field points to the associated target

    classDiagram\n\n        class TargetField{\n\n        }\n        TargetField --|> Field\n\nlink Field \"../Field\"
    "},{"location":"generated/proposal/TargetField/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/TargetObservation/","title":"objectType TargetObservation","text":"

    extends Observation

    an observation of the scientific target 

    classDiagram\n\n        class TargetObservation{\n\n        }\n        TargetObservation --|> Observation\n\nlink Observation \"../Observation\"
    "},{"location":"generated/proposal/TargetObservation/#members","title":"Members","text":"name type mult description"},{"location":"generated/proposal/TechnicalGoal/","title":"objectType TechnicalGoal","text":"

    collects together the technical goals of the proposal

    classDiagram\n\n        class TechnicalGoal{\n\n        }\n        TechnicalGoal *-- PerformanceParameters : performance\nTechnicalGoal *-- ScienceSpectralWindow : spectrum\n\nlink PerformanceParameters \"../PerformanceParameters\"\nlink ScienceSpectralWindow \"../ScienceSpectralWindow\"
    "},{"location":"generated/proposal/TechnicalGoal/#members","title":"Members","text":"name type mult description performance PerformanceParameters spectrum ScienceSpectralWindow 1 or more"},{"location":"generated/proposal/Telescope/","title":"objectType Telescope","text":"
    classDiagram\n\n        class Telescope{\n        ivoa:string name\nproposal:WikiDataId wikiId\ncoords:GeocentricPoint location\n\n        }\n
    "},{"location":"generated/proposal/Telescope/#members","title":"Members","text":"name type mult description name ivoa:string telescope name wikiId WikiDataId optional the wikidata id for the Instrument location coords:GeocentricPoint the location of the telescope"},{"location":"generated/proposal/TelescopeArray/","title":"objectType TelescopeArray","text":"

    a set of telescopes that are operated together for an observation

    classDiagram\n\n        class TelescopeArray{\n        ivoa:string name\n\n        }\n        TelescopeArray *-- TelescopeArrayMember : arrayMembers\n\nlink TelescopeArrayMember \"../TelescopeArrayMember\"
    "},{"location":"generated/proposal/TelescopeArray/#members","title":"Members","text":"name type mult description name ivoa:string the array name arrayMembers TelescopeArrayMember 1 or more the telescopes that make up the array"},{"location":"generated/proposal/TelescopeArrayMember/","title":"objectType TelescopeArrayMember","text":"
    classDiagram\n\n        class TelescopeArrayMember{\n\n        }\n        TelescopeArrayMember --> Telescope : telescope\n\nlink Telescope \"../Telescope\"
    "},{"location":"generated/proposal/TelescopeArrayMember/#members","title":"Members","text":"name type mult description telescope Telescope"},{"location":"generated/proposal/TextFormats/","title":"enumeration TextFormats","text":"

    acceptable text formats for document submission

    classDiagram\n\n        class TextFormats{\n           <<enumeration>>\nlatex\nrst\nasciidoc\n\n        }\n
    "},{"location":"generated/proposal/TextFormats/#values","title":"Values","text":"

    • latex - LaTeX using standard document style

    • rst - restructured text

    • asciidoc -

    "},{"location":"generated/proposal/TimingConstraint/","title":"abstract objectType TimingConstraint","text":"

    extends ObservingConstraint

    Any specific timing requirements for the observing

    classDiagram\n\n        class TimingConstraint{\n        ivoa:string note\nivoa:boolean isAvoidConstraint\n\n        }\n        TimingConstraint --|> ObservingConstraint\nTimingWindow --|> TimingConstraint\nSimultaneityConstraint --|> TimingConstraint\n\nlink ObservingConstraint \"../ObservingConstraint\"\nlink TimingWindow \"../TimingWindow\"\nlink SimultaneityConstraint \"../SimultaneityConstraint\"
    "},{"location":"generated/proposal/TimingConstraint/#members","title":"Members","text":"name type mult description note ivoa:string optional isAvoidConstraint ivoa:boolean optional"},{"location":"generated/proposal/TimingWindow/","title":"objectType TimingWindow","text":"

    extends TimingConstraint

    particular time range

    classDiagram\n\n        class TimingWindow{\n        ivoa:datetime startTime\nivoa:datetime endTime\n\n        }\n        TimingWindow --|> TimingConstraint\nTimingConstraint --|> ObservingConstraint\n\nlink TimingConstraint \"../TimingConstraint\"\nlink ObservingConstraint \"../ObservingConstraint\"
    "},{"location":"generated/proposal/TimingWindow/#members","title":"Members","text":"name type mult description startTime ivoa:datetime optional endTime ivoa:datetime optional"},{"location":"generated/proposal/WikiDataId/","title":"primitiveType WikiDataId","text":"

    a WikiData identifier

    "},{"location":"generated/proposalManagement/AllocatedBlock/","title":"objectType AllocatedBlock","text":"

    extends ResourceBlock

    A block of resources that have been allocated

    classDiagram\n\n        class AllocatedBlock{\n\n        }\n        AllocatedBlock --|> ResourceBlock\nAllocatedBlock --> AllocationGrade : grade\n\nlink ResourceBlock \"../ResourceBlock\"\nlink AllocationGrade \"../AllocationGrade\"
    "},{"location":"generated/proposalManagement/AllocatedBlock/#members","title":"Members","text":"name type mult description grade AllocationGrade"},{"location":"generated/proposalManagement/AllocatedProposal/","title":"objectType AllocatedProposal","text":"

    an instance of a proposal that is allocated observing time

    classDiagram\n\n        class AllocatedProposal{\n\n        }\n        AllocatedProposal --> SubmittedProposal : submitted\nAllocatedProposal *-- AllocatedBlock : allocation\n\nlink SubmittedProposal \"../SubmittedProposal\"\nlink AllocatedBlock \"../AllocatedBlock\"
    "},{"location":"generated/proposalManagement/AllocatedProposal/#members","title":"Members","text":"name type mult description allocation AllocatedBlock 1 or more what is allocated to the proposal submitted SubmittedProposal the proposal"},{"location":"generated/proposalManagement/AllocationGrade/","title":"objectType AllocationGrade","text":"

    The final grade given by the TAC

    classDiagram\n\n        class AllocationGrade{\n        ivoa:string name\nivoa:string description\n\n        }\n
    "},{"location":"generated/proposalManagement/AllocationGrade/#members","title":"Members","text":"name type mult description name ivoa:string the name of the grade description ivoa:string what this grade means"},{"location":"generated/proposalManagement/AvailableResources/","title":"objectType AvailableResources","text":"

    The list of resources that are available

    classDiagram\n\n        class AvailableResources{\n\n        }\n        AvailableResources *-- Resource : resources\n\nlink Resource \"../Resource\"
    "},{"location":"generated/proposalManagement/AvailableResources/#members","title":"Members","text":"name type mult description resources Resource 0 or more"},{"location":"generated/proposalManagement/CommitteeMember/","title":"objectType CommitteeMember","text":"

    a member of the TAC 

    classDiagram\n\n        class CommitteeMember{\n        proposalManagement:TacRole role\n\n        }\n        CommitteeMember --> Reviewer : member\n\nlink Reviewer \"../Reviewer\"
    "},{"location":"generated/proposalManagement/CommitteeMember/#members","title":"Members","text":"name type mult description role TacRole member Reviewer the member"},{"location":"generated/proposalManagement/OfferedCycles/","title":"objectType OfferedCycles","text":"
    classDiagram\n\n        class OfferedCycles{\n\n        }\n        OfferedCycles *-- ProposalCycle : cycles\n\nlink ProposalCycle \"../ProposalCycle\"
    "},{"location":"generated/proposalManagement/OfferedCycles/#members","title":"Members","text":"name type mult description cycles ProposalCycle 1 or more"},{"location":"generated/proposalManagement/ProposalCycle/","title":"objectType ProposalCycle","text":"

    Defines collection of resources and proposals for a particular observing season

    classDiagram\n\n        class ProposalCycle{\n        ivoa:string title\nivoa:datetime submissionDeadline\nivoa:datetime observationSessionStart\nivoa:datetime observationSessionEnd\n\n        }\n        ProposalCycle --> Observatory : observatory\nProposalCycle *-- ObservingMode : observingModes\nProposalCycle *-- AvailableResources : availableResources\nProposalCycle *-- AllocationGrade : possibleGrades\nProposalCycle *-- TAC : tac\nProposalCycle *-- SubmittedProposal : submittedProposals\nProposalCycle *-- ReviewedProposal : reviewedProposals\nProposalCycle *-- AllocatedProposal : allocatedProposals\n\nlink Observatory \"../../proposal/Observatory\"\nlink ObservingMode \"../../proposal/ObservingMode\"\nlink AvailableResources \"../AvailableResources\"\nlink AllocationGrade \"../AllocationGrade\"\nlink TAC \"../TAC\"\nlink SubmittedProposal \"../SubmittedProposal\"\nlink ReviewedProposal \"../ReviewedProposal\"\nlink AllocatedProposal \"../AllocatedProposal\"
    "},{"location":"generated/proposalManagement/ProposalCycle/#members","title":"Members","text":"name type mult description title ivoa:string a human readable description of the cycle submissionDeadline ivoa:datetime the date by which observing proposals must be submitted to be considered for this cycle observationSessionStart ivoa:datetime the start date of the observing cycle observationSessionEnd ivoa:datetime the end date of the observing cycle observingModes proposal:ObservingMode 1 or more the possible observing modes offered in the cycle availableResources AvailableResources possibleGrades AllocationGrade 1 or more The possible grades that can be allocated for this cycle tac TAC The time allocation committee submittedProposals SubmittedProposal 0 or more the proposals that have been submitted in this cycle reviewedProposals ReviewedProposal 0 or more the proposals that have been reviewed in this cycle allocatedProposals AllocatedProposal 0 or more the proposals that have been successful and allocated time observatory proposal:Observatory"},{"location":"generated/proposalManagement/ProposalReview/","title":"objectType ProposalReview","text":"

    A review of a proposal

    classDiagram\n\n        class ProposalReview{\n        ivoa:string comment\nivoa:real score\nivoa:boolean technicalFeasibility\nivoa:datetime reviewDate\n\n        }\n        ProposalReview --> Reviewer : reviewer\n\nlink Reviewer \"../Reviewer\"
    "},{"location":"generated/proposalManagement/ProposalReview/#members","title":"Members","text":"name type mult description comment ivoa:string Description score ivoa:real the review score technicalFeasibility ivoa:boolean is the proposal technically feasible reviewDate ivoa:datetime the date that the review is submitted reviewer Reviewer the reviewer making this review"},{"location":"generated/proposalManagement/Resource/","title":"objectType Resource","text":"

    A resource that will be consumed by allocating an observation from a proposal

    classDiagram\n\n        class Resource{\n        ivoa:real amount\n\n        }\n        Resource --> ResourceType : type\n\nlink ResourceType \"../ResourceType\"
    "},{"location":"generated/proposalManagement/Resource/#members","title":"Members","text":"name type mult description amount ivoa:real The amount of the resource type ResourceType the type of the resource"},{"location":"generated/proposalManagement/ResourceBlock/","title":"objectType ResourceBlock","text":"

    A block of resources that can be allocated

    classDiagram\n\n        class ResourceBlock{\n\n        }\n        AllocatedBlock --|> ResourceBlock\nResourceBlock --> ObservingMode : mode\nResourceBlock *-- Resource : resource\n\nlink AllocatedBlock \"../AllocatedBlock\"\nlink ObservingMode \"../../proposal/ObservingMode\"\nlink Resource \"../Resource\"
    "},{"location":"generated/proposalManagement/ResourceBlock/#members","title":"Members","text":"name type mult description resource Resource the amount of resource mode proposal:ObservingMode"},{"location":"generated/proposalManagement/ResourceType/","title":"objectType ResourceType","text":"

    a type of resource 

    classDiagram\n\n        class ResourceType{\n        ivoa:string name\nivoa:string unit\n\n        }\n
    "},{"location":"generated/proposalManagement/ResourceType/#members","title":"Members","text":"name type mult description name ivoa:string the name of the resource type unit ivoa:string"},{"location":"generated/proposalManagement/ReviewedProposal/","title":"objectType ReviewedProposal","text":"

    an instance of a proposal that is in review

    classDiagram\n\n        class ReviewedProposal{\n        ivoa:boolean successful\nivoa:datetime reviewsCompleteDate\n\n        }\n        ReviewedProposal --> SubmittedProposal : submitted\nReviewedProposal *-- ProposalReview : reviews\n\nlink SubmittedProposal \"../SubmittedProposal\"\nlink ProposalReview \"../ProposalReview\"
    "},{"location":"generated/proposalManagement/ReviewedProposal/#members","title":"Members","text":"name type mult description successful ivoa:boolean the proposal can go on to allocation reviewsCompleteDate ivoa:datetime the date when all the proposals are due reviews ProposalReview 1 or more the reviews submitted SubmittedProposal"},{"location":"generated/proposalManagement/Reviewer/","title":"objectType Reviewer","text":"

    assigned to review the proposal

    classDiagram\n\n        class Reviewer{\n\n        }\n        Reviewer --> Person : person\n\nlink Person \"../../proposal/Person\"
    "},{"location":"generated/proposalManagement/Reviewer/#members","title":"Members","text":"name type mult description person proposal:Person the person taking on the reviewer role"},{"location":"generated/proposalManagement/SubmittedProposal/","title":"objectType SubmittedProposal","text":"

    an instance of a proposal that has been submitted

    classDiagram\n\n        class SubmittedProposal{\n        ivoa:datetime submissionDate\n\n        }\n        SubmittedProposal --> ObservingProposal : proposal\n\nlink ObservingProposal \"../../proposal/ObservingProposal\"
    "},{"location":"generated/proposalManagement/SubmittedProposal/#members","title":"Members","text":"name type mult description submissionDate ivoa:datetime the date that the proposal was submitted proposal proposal:ObservingProposal the proposal that was submitted"},{"location":"generated/proposalManagement/TAC/","title":"objectType TAC","text":"

    time allocation committee

    classDiagram\n\n        class TAC{\n\n        }\n        TAC *-- CommitteeMember : members\n\nlink CommitteeMember \"../CommitteeMember\"
    "},{"location":"generated/proposalManagement/TAC/#members","title":"Members","text":"name type mult description members CommitteeMember 1 or more members of the committee"},{"location":"generated/proposalManagement/TacRole/","title":"enumeration TacRole","text":"

    A role within the timeAllocation committee

    classDiagram\n\n        class TacRole{\n           <<enumeration>>\nTechnicalReviewer\nScienceReviewer\nChair\n\n        }\n
    "},{"location":"generated/proposalManagement/TacRole/#values","title":"Values","text":"

    • TechnicalReviewer -

    • ScienceReviewer -

    • Chair -

    "}]} \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index c392c3ff24ea66a3df98e1f985bc6bca30de03c3..ad3c8d20ae1273fc388d2d204cbf4ebda3b7f679 100644 GIT binary patch delta 13 Ucmb=gXP58h;K*bzn#f)O02%B9vH$=8 delta 13 Ucmb=gXP58h;OPBZIFY>q03VJ7%K!iX