A structure for management of WCS FITS header keywords and associated image properties. More...

#include <WCSKeywords.h>

Public Member Functions
	WCSKeywords ()=default

	WCSKeywords (const PropertyArray &properties, const FITSKeywordArray &keywords=FITSKeywordArray())

	WCSKeywords (const WCSKeywords &)=default

void	Read (const PropertyArray &properties, const FITSKeywordArray &keywords=FITSKeywordArray())

PropertyArray	ToProperties () const

Public Attributes
Optional< double >	altobs
	Geodetic height of the observation location in meters.

Optional< double >	cd1_1
	Rotation and scaling matrix: CDELT1 * cos(CROTA2)

Optional< double >	cd1_2
	Rotation and scaling matrix: -CDELT2 * sin(CROTA2)

Optional< double >	cd2_1
	Rotation and scaling matrix: CDELT1 * sin(CROTA2)

Optional< double >	cd2_2
	Rotation and scaling matrix: CDELT2 * cos(CROTA2)

Optional< double >	cdelt1
	Plate scale in degrees per pixel at the reference pixel, X axis.

Optional< double >	cdelt2
	Plate scale in degrees per pixel at the reference pixel, Y axis.

Optional< double >	crota1
	Rotation angle around the reference pixel in degrees. Same as CROTA2, unused.

Optional< double >	crota2
	Rotation angle around the reference pixel in degrees.

Optional< double >	crpix1
	Image coordinate of the reference point on the X axis.

Optional< double >	crpix2
	Image coordinate of the reference point on the Y axis.

Optional< double >	crval1
	WCS coordinate at the reference point, X axis.

Optional< double >	crval2
	WCS coordinate at the reference point, Y axis.

IsoString	ctype1
	Coordinate type and projection, X axis.

IsoString	ctype2
	Coordinate type and projection, Y axis.

Optional< double >	dateend
	Observation end time as a Julian date, UTC timescale.

Optional< double >	dateobs
	Observation start time as a Julian date, UTC timescale.

Optional< double >	equinox
	Equinox in years for the celestial coordinate system (not applicable if radesys = ICRS \| GCRS).

Optional< double >	focallen
	Focal length in millimeters.

Optional< double >	latobs
	Geodetic latitude of the observation location in degrees. Reckoned positive north of the equator.

Optional< double >	latpole
	Native latitude of the celestial north pole in degrees.

Optional< double >	longobs
	Geodetic longitude of the observation location in degrees. Reckoned positive east of the reference meridian.

Optional< double >	lonpole
	Native longitude of the celestial north pole in degrees.

Optional< double >	objctdec
	Declination coordinate of the center of the image in degrees.

Optional< double >	objctra
	Right ascension coordinate of the center of the image in degrees.

Optional< double >	pv1_1
	Native longitude of the reference point in degrees.

Optional< double >	pv1_2
	Native latitude of the reference point in degrees.

IsoString	radesys
	Reference system of celestial coordinates.

Optional< double >	xpixsz
	Pixel size in micrometers.

Detailed Description

References

M. R. Calabretta, E. W. Greisen (2002) Representations of World Coordinates in FITS, Astronomy & Astrophysics, 395, 1061-1075, 1077-1122.

Definition at line 88 of file WCSKeywords.h.

Constructor & Destructor Documentation

◆ WCSKeywords() [1/3]

pcl::WCSKeywords::WCSKeywords ( )

default

Default constructor. Constructs an uninitialized/undefined WCSKeywords object.

◆ WCSKeywords() [2/3]

pcl::WCSKeywords::WCSKeywords ( const WCSKeywords & )

default

Copy constructor.

◆ WCSKeywords() [3/3]

pcl::WCSKeywords::WCSKeywords	(	const PropertyArray &	properties,
		const FITSKeywordArray &	keywords = `FITSKeywordArray()`
	)

inline

Constructs a WCSKeywords object by extracting data from the specified arrays of image properties and FITS keywords.

Metadata items available as image properties take precedence over equivalent FITS keywords.

Definition at line 140 of file WCSKeywords.h.

Member Function Documentation

◆ Read()

void pcl::WCSKeywords::Read	(	const PropertyArray &	properties,
		const FITSKeywordArray &	keywords = `FITSKeywordArray()`
	)

Extracts WCS metadata from the specified arrays of image properties and FITS keywords.

If some metadata items are not included in the properties and keywords arrays, the previously defined items, if any, will be preserved.

Metadata items available as image properties take precedence over equivalent FITS keywords.

◆ ToProperties()

PropertyArray pcl::WCSKeywords::ToProperties ( ) const

Generates a dynamic array of XISF properties equivalent to the metadata currently stored in this object. The returned array includes the following properties when the corresponding items are defined:

Observation:Center:RA
Observation:Center:Dec
Observation:CelestialReferenceSystem
Observation:Equinox
Observation:Time:Start
Observation:Time:End
Observation:Location:Longitude
Observation:Location:Latitude
Observation:Location:Elevation
Instrument:Telescope:FocalLength
Instrument:Sensor:XPixelSize
Instrument:ExposureTime
PCL:AstrometricSolution:ProjectionSystem
PCL:AstrometricSolution:ReferenceCelestialCoordinates
PCL:AstrometricSolution:ReferenceImageCoordinates
PCL:AstrometricSolution:ReferenceNativeCoordinates
PCL:AstrometricSolution:CelestialPoleNativeCoordinates
PCL:AstrometricSolution:LinearTransformationMatrix

The documentation for this class was generated from the following file:

WCSKeywords.h

Public Member Functions

Public Attributes