TransformParameters

class jwst.lib.set_telescope_pointing.TransformParameters(allow_default: bool = False, default_pa_v3: float = 0.0, detector: str = None, dry_run: bool = False, engdb_url: str = None, exp_type: str = None, fgsid: int = None, fsmcorr_version: str = 'latest', fsmcorr_units: str = 'arcsec', guide_star_wcs: WCSRef = (None, None, None), j2fgs_transpose: bool = True, jwst_velocity: array = None, method: Methods = Methods.OPS_TR_202111, obsend: float = None, obsstart: float = None, override_transforms: Transforms = None, pcs_mode: str = None, pointing: Pointing = None, reduce_func: Callable = None, siaf: SIAF = None, siaf_db: SiafDb = None, tolerance: float = 60.0, useafter: str = None, v3pa_at_gs: float = None)[source]

Bases: object

Parameters required the calculations

Attributes Summary

`allow_default`	If telemetry cannot be determined, use existing information in the observation's header.
`default_pa_v3`	The V3 position angle to use if the pointing information is not found.
`detector`	Detector in use.
`dry_run`	Do not write out the modified file.
`engdb_url`	URL of the engineering telemetry database REST interface.
`exp_type`	Exposure type
`fgsid`	FGS to use as the guiding FGS.
`fsmcorr_units`	Units of the FSM correction values.
`fsmcorr_version`	The version of the FSM correction calculation to use.
`guide_star_wcs`	Guide star WCS info, typically from the input model.
`j2fgs_transpose`	Transpose the `j2fgs1` matrix.
`jwst_velocity`	The [DX, DY, DZ] barycentri velocity vector
`method`	The method, or algorithm, to use in calculating the transform.
`obsend`	Observation end time
`obsstart`	Observation start time
`override_transforms`	If set, matrices that should be used instead of the calculated one.
`pcs_mode`	The tracking mode in use.
`pointing`	The observatory orientation, represented by the ECI quaternion, and other engineering mnemonics
`reduce_func`	Reduction function to use on values.
`siaf`	The SIAF information for the input model
`siaf_db`	The SIAF database
`tolerance`	If no telemetry can be found during the observation, the time, in seconds, beyond the observation time to search for telemetry.
`useafter`	The date of observation (`jwst.datamodels.JwstDataModel.meta.date`)
`v3pa_at_gs`	V3 position angle at Guide Star (`jwst.datamodels.JwstDataModel.meta.guide_star.gs_v3_pa_science`)

Methods Summary

`as_reprdict`()	Return a dict where all values are REPR of their values
`update_pointing`()	Update pointing information

Attributes Documentation

allow_default: bool = False: If telemetry cannot be determined, use existing information in the observation’s header.

default_pa_v3: float = 0.0: The V3 position angle to use if the pointing information is not found.

detector: str = None: Detector in use.

dry_run: bool = False: Do not write out the modified file.

engdb_url: str = None: URL of the engineering telemetry database REST interface.

exp_type: str = None: Exposure type

fgsid: int = None: FGS to use as the guiding FGS. If None, will be set to what telemetry provides.

fsmcorr_units: str = 'arcsec': Units of the FSM correction values. Default is ‘arcsec’. See calc_sifov_fsm_delta_matrix

fsmcorr_version: str = 'latest': The version of the FSM correction calculation to use. See calc_sifov_fsm_delta_matrix

guide_star_wcs: WCSRef = (None, None, None): Guide star WCS info, typically from the input model.

j2fgs_transpose: bool = True: Transpose the j2fgs1 matrix.

jwst_velocity: array = None: The [DX, DY, DZ] barycentri velocity vector

method: Methods = 'ops_tr_202111': The method, or algorithm, to use in calculating the transform. If not specified, the default method is used.

obsend: float = None: Observation end time

obsstart: float = None: Observation start time

override_transforms: Transforms = None: If set, matrices that should be used instead of the calculated one.

pcs_mode: str = None: The tracking mode in use.

pointing: Pointing = None: The observatory orientation, represented by the ECI quaternion, and other engineering mnemonics

reduce_func: Callable = None: Reduction function to use on values.

siaf: SIAF = None: The SIAF information for the input model

siaf_db: SiafDb = None: The SIAF database

tolerance: float = 60.0: If no telemetry can be found during the observation, the time, in seconds, beyond the observation time to search for telemetry.

useafter: str = None: The date of observation (jwst.datamodels.JwstDataModel.meta.date)

v3pa_at_gs: float = None: V3 position angle at Guide Star (jwst.datamodels.JwstDataModel.meta.guide_star.gs_v3_pa_science)

Methods Documentation

as_reprdict()[source]: Return a dict where all values are REPR of their values

update_pointing()[source]: Update pointing information