-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
rcal-936 Update docs and add skycell_asn as a script at install time
- Loading branch information
1 parent
0a530f2
commit c6aa6dd
Showing
4 changed files
with
94 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,3 +7,4 @@ Association Commands | |
:maxdepth: 2 | ||
|
||
asn_from_list.rst | ||
skycell_asn.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
.. _skycell_asn: | ||
|
||
skycell_asn | ||
=========== | ||
|
||
Create an association using either the command line tool | ||
``skycell_asn`` or through the Python API using either | ||
:class:`romancal.associations.skycell_asn.Main` or | ||
:func:`romancal.associations.skycellasn.skycell_asn` | ||
|
||
|
||
Associations | ||
^^^^^^^^^^^^ | ||
|
||
Refer to TBD for a full description of associations. | ||
|
||
To create an association, use the following command: | ||
|
||
.. code-block:: python | ||
skycell_asn file_list -o my_program | ||
where the individual calibrated detector files are in the current directory and the -o is the root | ||
for the output associations. To get a complete list of options you can run the command with the | ||
\-h option | ||
|
||
.. code-block:: python | ||
skycell_asn -h | ||
By knowing the structure of the conventional file name you can generate custom associations based | ||
on the information included in the file names. | ||
The current naming convention for the input files consists of a Visit_ID + Exposure_ID + detector + suffix | ||
Where the Visit_ID is a 19 digit string | ||
PPPPPCCAAASSSOOOVVV, with | ||
|
||
PPPPP = Program number | ||
CC = Execution plan number | ||
AAA = Pass number (within execution plan) | ||
SSS = Segment Number (within pass) | ||
OOO = Observation number (within the leg, not to be confused with the Observation ID) | ||
VVV = Visit Number (within the observation) | ||
|
||
and the Exposure_ID is a four digits designating the exposures | ||
|
||
eeee = Exposure number (within the visit) | ||
|
||
The detector is WFI01, WFI02, ... WFI18 | ||
|
||
The suffix indicates the processing level of the file and to create products based on the | ||
skycells the suffix should generally be 'cal'. | ||
|
||
and the file name is constructed as, | ||
rPPPPPCCAAASSSOOOVVV_eeee_detector_suffix.asdf | ||
|
||
To give a more concrete example we'll use the APT example program for the | ||
High Latitude Wide Angle Survey (hlwas). The program is 00991, the execution plan number is 01, | ||
there are 12 passes, 5 segments, 4 observations and a various number of visits. | ||
For this example we want to select a single filter, say F158, and that is segment 003. | ||
So to generate the visit level associations for observation 001 we would select the files using the bash | ||
command line, | ||
|
||
.. code-block:: text | ||
skycell_asn r0099101001003001001_*_cal.asdf -o r0099101001003001001 --product-type visit | ||
Where the wildcard selects all the exposures for visit 001 and generates associations based on the skycells | ||
the exposures will populate. This will generate associations based the skycells that the exposures can | ||
contribute data to. The association files will be json files with names based | ||
|
||
.. code-block:: text | ||
r0099101001003001001_<skycell name>_<product_type>_<filter>_<release product name>_i2d_asn.json | ||
or for the selections above | ||
|
||
.. code-block:: text | ||
r0099101001003001001_r257dp63x98y83_visit_F158_prompt_i2d_asn.json | ||
where the skycell name can vary based on the location on the celestial sphere and the i2d indicates | ||
that this is resampled 2-d imaging data. The release product name can be changed from the default | ||
by adding the optional argument --release-product <new name> to the command line. | ||
|
||
An analogous command to generate the pass level products, again setting segment to 003 to only select | ||
the F158 filter. | ||
|
||
.. code-block:: text | ||
skycell_asn r0099101???003*_*_cal.asdf -o r0099101001003001001 --product-type pass |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters