Page History
| Excerpt | ||
|---|---|---|
| ||
Learn the file name template for science products |
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
On this page...
|
File Name Components
Names of science files must follow the naming scheme described here. This convention permits easy integration with MAST in a way that allows for automated searches. Components of file names in black bold text, including underscores and periods, are literal text; items in green italic text are symbolic, and are explained below. The name template is:
hlsp_proj-id_observatory_instrument_target_opt-elem_version_product-type.extension
Where the components are:
| Component | Description |
|---|---|
hlsp | A literal string that identifies the file as a community-contributed data product |
| An agreed upon identifier for the HLSP collection (e.g. a project acronym). This name is also used in MAST as directory name and as a database keyword. |
| Primary observatory used to acquire the data. If multiple observatories were used, acronyms may be separated by hyphens (e.g., hst-fuse). |
instrument | Instrument acronym (and if applicable, channel) used to obtain the data (e.g. |
target | Field name or target as designated by the team. Parts, counter numbers, and epochs are allowed in this field and should be separated by hyphens. Counters can be used when the same field is observed multiple times with the same observing parameters.
Please describe your usage of field-name parts and counters within the collection README file. |
opt-elem | Names of optical element(s) (i.e., filter or dispersing element) used to obtain the data.
|
version | Version designation used by the team for the HLSP delivery, such as |
product-type | Type of data as designated by the team (models/simulations can be indicated here). Please use a widely recognized type when possible; examples include: |
extension | Standard extension name for the file format, e.g. |
Other Requirements
- Use lower-case characters only.
- Only use underscores to delineate major fields (e.g.
goods_hst). - Appending an extension beyond the standard one, indicating the output of a common compression algorithm, is acceptable: e.g.,
.gzor.bz2
Recommendations
- Within fields, dashes can be used as separators (e.g.
nicmos-nic3,acs-wfc,m101-01). - Version numbers can be specific to the project. We recommend that teams use increasing version numbers to make it easy to tell which data are superseded; MAST will NOT keep older versions of datasets unless the team demonstrates a need for it. Note that sometimes version numbers may denote single-EPOCH (data as in the GOODS collection); this sort of information must be documented well with deliveries.
- Re-delivered data should be given a higher version number (to indicate better products); the newest deliveries should contain both the re-processed data along with the single-epoch data associated with these products, if applicable.
- All images identified using the same field-name should cover approximately the same area of the sky. If there are multiple images covering different parts of a field or source, they should have different field-names.
Example File Names
A drizzle-combined image of the GOODS field, obtained with the HST/ACS camera WFC channel using the F435W filter:
hlsp_goods_hst_acs-wfc_north-sect13_f435w_v2.0_drz.fits
An image of the Hubble ultra-deep field obtained with the HST/NICMOS NIC3 camera using the F110W filter:
hlsp_udf_hst_nicmos-nic3_treasury_f110w_v2_img.fits
A text catalog from the 47 Tuc from the DEEP47TUC survey obtained with HST/ACS, containing stellar magnitudes in the F606W and F814W filters:
hlsp_deep47tuc_hst_acs_47tuc_f606w-f814w_v1_catalog.txt
A 1-D SED of the target AV-95 from the ULLYSES survey, obtained with HST/STIS and FUSE (note that multiple gratings were used, so the spectral element is just referred to as uv) :
hlsp_ullyses_hst-fuse_fuse-stis_av95_uv_dr2_sed.fits