Note

For a description of the style convention and how JSON structures are documented see section JSON Data Structures.

Named JSON structures are indicated as {JSON}.

Start DAQ v2

StartDaqV2Specification {JSON}

(object)

Specifies the specification parameter in daqif.OcmDaqControl.StartDaqV2().

Simple example:

{
  "sources": [
    {
      "rrUri": "zpb.rr://127.0.0.1:48005/daq",
      "sourceName": "tcs",
      "type": "metadataSource"
    }
  ]
}

New in version 2.1.0.

sources (List[Union[PrimarySource, MetadataSource, FitsKeywordsSource, FitsFileSource]])

Specifies list of sources to either acquire from (PrimarySource, MetadataSource) or data that already exist and should simply be merged (FitsKeywordsSource and FitsFileSource).

The order is significant in that it determines the merge order in descending priority order.

mergeTarget (Optional[object])

Optionally specifies a single FITS file that should be used as the in-place merge target into which all other acquired data will be merged.

sourceName (str)

Identifies the source that should be used as merge target. First FITS file result from the source will be used as in-place target.

receivers (Optional[ReceiverList])

Specifies the list (ReceiverList {JSON}) of receivers that daqDpmServer release the Data Product to. Normally this is foreseen to include OLAS.

New in version 3.0.0.

filePrefix (Optional[str])

Optional file prefix.

Note

This does not affect the archive name of the file, only the intermedate files used to create the final Data Product.

awaitCompletionInterval (Optional[Union[float, integer]]) [default: 10.0]

This is the interval, in seconds, between requests sent to data sources to await the completion of the Data Acquisition. If this number exceed the MAL timeout it will stop working.

Note that this is not a polling interval where shorter time will be more responsive. If await condition is fulfilled the reply will be sent immediately.

See also

See PrimarySource, MetadataSource, FitsKeywordsSource, FitsFileSource and ReceiverList {JSON}.

PrimarySource {JSON}

(object)

Specifies a primary data source that implements the MAL interface recif (e.g. detector).

type (“primarySource”)

This is a union discriminator and must have the literal string value "primarySource".

sourceName (str)

Name for this source.

rrUri (str)

recif MAL request-reply URI.

alertUnmergeable (bool) [true]

Controls whether unmerged primary HDU data is alerted.

In the merge process daqDpmMerge will copy each FITS extension to the target data product but this is not done for the primary HDU as data might be overwritten. When true an alert is created if this is encountered.

See also

See Unmerged Data for alert details.

initialKeywords (Optional[Union[“user”, “none”]]) [default: “user”]

Determines the initial set of keywords passed to keywordRules and later copied to primary HDU when merged.

keywordRules (Optional[KeywordRules]) [default: []]

Optional list of keyword rules to further specify how keywords are merged. The initial keywords are determined from initialKeywords.

See also

See KeywordRules.

MetadataSource {JSON}

(object)

Specifies a metadata source that implement the MAL interface metadaqif (e.g. ICS Device Manager).

type (“metadataSource”)

This is a union discriminator and must have the literal string value "metadataSource".

sourceName (str)

Name for this source.

rrUri (str)

metadaqif MAL request-reply URI.

alertUnmergeable (bool) [true]

Controls whether unmerged primary HDU data is alerted.

In the merge process daqDpmMerge will copy each FITS extension to the target data product but this is not done for the primary HDU as data might be overwritten. When true an alert is created if this is encountered.

See also

See Unmerged Data for alert details.

initialKeywords (Optional[Union[“user”, “none”]]) [default: “user”]

Determines the initial set of keywords passed to keywordRules and later copied to primary HDU when merged.

keywordRules (Optional[KeywordRules]) [default: []]

Optional list of keyword rules to further specify how keywords are merged. The initial keywords are determined from initialKeywords.

See also

See KeywordRules.

FitsFileSource {JSON}

(object)

Describes a source FITS file that either acts as an in-place target or should be merged in the final Data Product.

Keywords from FITS file in location will be processed by the keywordRules before merging them to final Data Product primary HDU.

FITS extensions will be copied as-is.

type (“fitsFile”)

This is a union discriminator and must have the literal string value "fitsFile".

sourceName (str)

Identifies the source.

location (str)

File location as host:/path/to/file.fits format. This is the location as originally provided by the source to daqOcmServer. It is permitted to emit the hostname in which case the path must be accessible locally by DPM.

alertUnmergeable (bool) [true]

Controls whether unmerged primary HDU data is alerted.

In the merge process daqDpmMerge will copy each FITS extension to the target data product but this is not done for the primary HDU as data might be overwritten. When true an alert is created if this is encountered.

See also

See Unmerged Data for alert details.

initialKeywords (Optional[Union[“user”, “none”]]) [default: “user”]

Determines the initial set of keywords passed to keywordRules and later copied to primary HDU when merged.

keywordRules (Optional[KeywordRules]) [default: []]

Optional list of keyword rules to further specify how keywords are merged. The initial keywords are determined from initialKeywords.

See also

See KeywordRules.

FitsKeywordsSource {JSON}

(object)

Specifies a list of keywords from a source that should be merged to final Data Product primary HDU.

Keywords from keywords are processed by the keywordRules and then merged to Data Product.

type (“fitsKeywords”)

This is a union discriminator and must have the literal string value "fitsKeywords".

sourceName (str)

Identifies the source, as provided to OCM by client.

keywords (List[FitsKeyword])

List of FITS keywords.

initialKeywords (Optional[Union[“user”, “none”]]) [default: “user”]

Determines the initial set of keywords passed to keywordRules and later copied to primary HDU when merged.

keywordRules (Optional[KeywordRules]) [default: []]

Optional list of keyword rules to further specify how keywords are merged. The initial keywords are determined from initialKeywords.

See also

See FitsKeyword and KeywordRules.