PCL
WCSKeywords.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/WCSKeywords.h - Released 2024-06-18T15:48:54Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_WCSKeywords_h
53 #define __PCL_WCSKeywords_h
54 
56 
57 #include <pcl/Defs.h>
58 
59 #include <pcl/FITSHeaderKeyword.h>
60 #include <pcl/Optional.h>
61 #include <pcl/Property.h>
62 #include <pcl/String.h>
63 
64 /*
65  * Based on original work contributed by AndrĂ©s del Pozo.
66  */
67 
68 namespace pcl
69 {
70 
71 // ----------------------------------------------------------------------------
72 
73 class LinearTransformation;
74 
88 class PCL_CLASS WCSKeywords
89 {
90 public:
91 
121 
126  WCSKeywords() = default;
127 
131  WCSKeywords( const WCSKeywords& ) = default;
132 
140  WCSKeywords( const PropertyArray& properties, const FITSKeywordArray& keywords = FITSKeywordArray() )
141  {
142  Read( properties, keywords );
143  }
144 
156  void Read( const PropertyArray& properties, const FITSKeywordArray& keywords = FITSKeywordArray() );
157 
185 
189  bool ExtractWorldTransformation( LinearTransformation& transIW, int imageHeight );
190 
191 private:
192 
193  bool m_fromFITS = false;
194 };
195 
196 // ----------------------------------------------------------------------------
197 
198 } // pcl
199 
200 #endif // __PCL_WCSKeywords_h
201 
202 // ----------------------------------------------------------------------------
203 // EOF pcl/WCSKeywords.h - Released 2024-06-18T15:48:54Z
Generic dynamic array.
Definition: Array.h:100
Eight-bit string (ISO/IEC-8859-1 or UTF-8 string)
Definition: String.h:5425
A linear geometric transformation on the plane defined as a 2x3 matrix of 64-bit floating point scala...
A structure for management of WCS FITS header keywords and associated image properties.
Definition: WCSKeywords.h:89
Optional< double > xpixsz
Pixel size in micrometers.
Definition: WCSKeywords.h:102
Optional< double > objctra
Right ascension coordinate of the center of the image in degrees.
Definition: WCSKeywords.h:92
Optional< double > altobs
Geodetic height of the observation location in meters.
Definition: WCSKeywords.h:100
Optional< double > equinox
Equinox in years for the celestial coordinate system (not applicable if radesys = ICRS | GCRS).
Definition: WCSKeywords.h:95
Optional< double > crpix2
Image coordinate of the reference point on the Y axis.
Definition: WCSKeywords.h:106
Optional< double > longobs
Geodetic longitude of the observation location in degrees. Reckoned positive east of the reference me...
Definition: WCSKeywords.h:98
Optional< double > crpix1
Image coordinate of the reference point on the X axis.
Definition: WCSKeywords.h:105
Optional< double > latobs
Geodetic latitude of the observation location in degrees. Reckoned positive north of the equator.
Definition: WCSKeywords.h:99
Optional< double > lonpole
Native longitude of the celestial north pole in degrees.
Definition: WCSKeywords.h:119
Optional< double > crota2
Rotation angle around the reference pixel in degrees.
Definition: WCSKeywords.h:114
Optional< double > cd2_2
Rotation and scaling matrix: CDELT2 * cos(CROTA2)
Definition: WCSKeywords.h:110
Optional< double > focallen
Focal length in millimeters.
Definition: WCSKeywords.h:101
Optional< double > crval1
WCS coordinate at the reference point, X axis.
Definition: WCSKeywords.h:103
PropertyArray ToProperties() const
Optional< double > crota1
Rotation angle around the reference pixel in degrees. Same as CROTA2, unused.
Definition: WCSKeywords.h:113
Optional< double > dateobs
Observation start time as a Julian date, UTC timescale.
Definition: WCSKeywords.h:96
IsoString radesys
Reference system of celestial coordinates.
Definition: WCSKeywords.h:94
WCSKeywords()=default
Optional< double > pv1_1
Native longitude of the reference point in degrees.
Definition: WCSKeywords.h:117
Optional< double > dateend
Observation end time as a Julian date, UTC timescale.
Definition: WCSKeywords.h:97
Optional< double > cd1_1
Rotation and scaling matrix: CDELT1 * cos(CROTA2)
Definition: WCSKeywords.h:107
Optional< double > cdelt1
Plate scale in degrees per pixel at the reference pixel, X axis.
Definition: WCSKeywords.h:111
WCSKeywords(const WCSKeywords &)=default
Optional< double > crval2
WCS coordinate at the reference point, Y axis.
Definition: WCSKeywords.h:104
WCSKeywords(const PropertyArray &properties, const FITSKeywordArray &keywords=FITSKeywordArray())
Definition: WCSKeywords.h:140
Optional< double > pv1_2
Native latitude of the reference point in degrees.
Definition: WCSKeywords.h:118
Optional< double > objctdec
Declination coordinate of the center of the image in degrees.
Definition: WCSKeywords.h:93
Optional< double > cdelt2
Plate scale in degrees per pixel at the reference pixel, Y axis.
Definition: WCSKeywords.h:112
void Read(const PropertyArray &properties, const FITSKeywordArray &keywords=FITSKeywordArray())
Optional< double > latpole
Native latitude of the celestial north pole in degrees.
Definition: WCSKeywords.h:120
Optional< double > cd2_1
Rotation and scaling matrix: CDELT1 * sin(CROTA2)
Definition: WCSKeywords.h:109
IsoString ctype2
Coordinate type and projection, Y axis.
Definition: WCSKeywords.h:116
Optional< double > cd1_2
Rotation and scaling matrix: -CDELT2 * sin(CROTA2)
Definition: WCSKeywords.h:108
IsoString ctype1
Coordinate type and projection, X axis.
Definition: WCSKeywords.h:115
PCL root namespace.
Definition: AbstractImage.h:77