Skip to main content

rfitsio/
types.rs

1//! FITS / CFITSIO constants and datatype enumerations.
2
3/// Behavioral oracle: CFITSIO 4.7.0.
4pub const CFITSIO_MAJOR: u32 = 4;
5pub const CFITSIO_MINOR: u32 = 7;
6pub const CFITSIO_MICRO: u32 = 0;
7pub const CFITSIO_SONAME: u32 = 10;
8
9/// `ffvers` encoding: `major + 0.01 * minor + 0.0001 * micro`.
10#[must_use]
11pub fn cfitsio_version_float() -> f32 {
12    CFITSIO_MAJOR as f32 + 0.01 * CFITSIO_MINOR as f32 + 0.0001 * CFITSIO_MICRO as f32
13}
14
15/// FITS logical record size in bytes. Do not change.
16pub const RECORD_LEN: usize = 2880;
17/// Cards per header record (`RECORD_LEN / CARD_LEN`).
18pub const CARDS_PER_RECORD: usize = 36;
19
20pub const FLEN_FILENAME: usize = 1025;
21pub const FLEN_KEYWORD: usize = 75;
22pub const FLEN_CARD: usize = 81;
23pub const CARD_LEN: usize = 80;
24pub const FLEN_VALUE: usize = 71;
25pub const FLEN_COMMENT: usize = 73;
26pub const FLEN_ERRMSG: usize = 81;
27
28pub const TBIT: i32 = 1;
29pub const TBYTE: i32 = 11;
30pub const TSBYTE: i32 = 12;
31pub const TLOGICAL: i32 = 14;
32pub const TSTRING: i32 = 16;
33pub const TUSHORT: i32 = 20;
34pub const TSHORT: i32 = 21;
35pub const TUINT: i32 = 30;
36pub const TINT: i32 = 31;
37pub const TULONG: i32 = 40;
38pub const TLONG: i32 = 41;
39pub const TINT32BIT: i32 = 41;
40pub const TFLOAT: i32 = 42;
41pub const TULONGLONG: i32 = 80;
42pub const TLONGLONG: i32 = 81;
43pub const TDOUBLE: i32 = 82;
44pub const TCOMPLEX: i32 = 83;
45pub const TDBLCOMPLEX: i32 = 163;
46
47pub const TYP_STRUC_KEY: i32 = 10;
48pub const TYP_CMPRS_KEY: i32 = 20;
49pub const TYP_SCAL_KEY: i32 = 30;
50pub const TYP_NULL_KEY: i32 = 40;
51pub const TYP_DIM_KEY: i32 = 50;
52pub const TYP_RANG_KEY: i32 = 60;
53pub const TYP_UNIT_KEY: i32 = 70;
54pub const TYP_DISP_KEY: i32 = 80;
55pub const TYP_HDUID_KEY: i32 = 90;
56pub const TYP_CKSUM_KEY: i32 = 100;
57pub const TYP_WCS_KEY: i32 = 110;
58pub const TYP_REFSYS_KEY: i32 = 120;
59pub const TYP_COMM_KEY: i32 = 130;
60pub const TYP_CONT_KEY: i32 = 140;
61pub const TYP_USER_KEY: i32 = 150;
62
63/// Image BITPIX / CFITSIO unsigned-image codes.
64#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
65pub enum ImageType {
66    /// `BYTE_IMG` / BITPIX = 8.
67    U8,
68    /// `SBYTE_IMG` / BITPIX = 8 + BZERO = -128.
69    I8,
70    /// `SHORT_IMG` / BITPIX = 16.
71    I16,
72    /// `USHORT_IMG` / BITPIX = 16 + BZERO = 32768.
73    U16,
74    /// `LONG_IMG` / BITPIX = 32.
75    I32,
76    /// `ULONG_IMG` / BITPIX = 32 + BZERO = 2^31.
77    U32,
78    /// `LONGLONG_IMG` / BITPIX = 64.
79    I64,
80    /// `ULONGLONG_IMG` / BITPIX = 64 + BZERO = 2^63.
81    U64,
82    /// `FLOAT_IMG` / BITPIX = -32.
83    F32,
84    /// `DOUBLE_IMG` / BITPIX = -64.
85    F64,
86}
87
88impl ImageType {
89    /// CFITSIO `ffcrim` / `ffphps` bitpix argument (includes 10/20/40/80).
90    #[must_use]
91    pub const fn code(self) -> i32 {
92        match self {
93            Self::U8 => BYTE_IMG,
94            Self::I8 => SBYTE_IMG,
95            Self::I16 => SHORT_IMG,
96            Self::U16 => USHORT_IMG,
97            Self::I32 => LONG_IMG,
98            Self::U32 => ULONG_IMG,
99            Self::I64 => LONGLONG_IMG,
100            Self::U64 => ULONGLONG_IMG,
101            Self::F32 => FLOAT_IMG,
102            Self::F64 => DOUBLE_IMG,
103        }
104    }
105
106    /// BITPIX actually stored in the header.
107    #[must_use]
108    pub const fn bitpix(self) -> i32 {
109        match self {
110            Self::U8 | Self::I8 => 8,
111            Self::I16 | Self::U16 => 16,
112            Self::I32 | Self::U32 => 32,
113            Self::I64 | Self::U64 => 64,
114            Self::F32 => -32,
115            Self::F64 => -64,
116        }
117    }
118
119    /// Bytes per stored pixel.
120    #[must_use]
121    pub const fn bytes_per_pixel(self) -> usize {
122        match self.bitpix().unsigned_abs() {
123            8 => 1,
124            16 => 2,
125            32 => 4,
126            64 => 8,
127            _ => 1,
128        }
129    }
130
131    /// Default BSCALE.
132    #[must_use]
133    pub const fn bscale(self) -> f64 {
134        1.0
135    }
136
137    /// Default BZERO for unsigned / signed-byte images.
138    #[must_use]
139    pub const fn bzero(self) -> f64 {
140        match self {
141            Self::I8 => -128.0,
142            Self::U16 => 32768.0,
143            Self::U32 => 2_147_483_648.0,
144            Self::U64 => 9_223_372_036_854_775_808.0,
145            _ => 0.0,
146        }
147    }
148
149    /// Parse a CFITSIO image-type code (including 10/20/40/80).
150    #[must_use]
151    pub const fn from_code(code: i32) -> Option<Self> {
152        match code {
153            BYTE_IMG => Some(Self::U8),
154            SBYTE_IMG => Some(Self::I8),
155            SHORT_IMG => Some(Self::I16),
156            USHORT_IMG => Some(Self::U16),
157            LONG_IMG => Some(Self::I32),
158            ULONG_IMG => Some(Self::U32),
159            LONGLONG_IMG => Some(Self::I64),
160            ULONGLONG_IMG => Some(Self::U64),
161            FLOAT_IMG => Some(Self::F32),
162            DOUBLE_IMG => Some(Self::F64),
163            _ => None,
164        }
165    }
166}
167
168pub const BYTE_IMG: i32 = 8;
169pub const SHORT_IMG: i32 = 16;
170pub const LONG_IMG: i32 = 32;
171pub const LONGLONG_IMG: i32 = 64;
172pub const FLOAT_IMG: i32 = -32;
173pub const DOUBLE_IMG: i32 = -64;
174pub const SBYTE_IMG: i32 = 10;
175pub const USHORT_IMG: i32 = 20;
176pub const ULONG_IMG: i32 = 40;
177pub const ULONGLONG_IMG: i32 = 80;
178
179pub const IMAGE_HDU: i32 = 0;
180pub const ASCII_TBL: i32 = 1;
181pub const BINARY_TBL: i32 = 2;
182pub const ANY_HDU: i32 = -1;
183
184pub const READONLY: i32 = 0;
185pub const READWRITE: i32 = 1;
186
187pub const CASESEN: i32 = 1;
188pub const CASEINSEN: i32 = 0;
189
190/// Maximum number of axes in a tiled compressed image (`MAX_COMPRESS_DIM`).
191pub const MAX_COMPRESS_DIM: usize = 6;
192
193/// Rice coding (`RICE_1`).
194pub const RICE_1: i32 = 11;
195/// gzip of the raw tile bytes (`GZIP_1`).
196pub const GZIP_1: i32 = 21;
197/// byte-shuffle then gzip (`GZIP_2`).
198pub const GZIP_2: i32 = 22;
199/// IRAF pixel-list coding (`PLIO_1`).
200pub const PLIO_1: i32 = 31;
201/// H-transform coding (`HCOMPRESS_1`).
202pub const HCOMPRESS_1: i32 = 41;
203/// Internal CFITSIO test codec; not a public FITS type.
204pub const BZIP2_1: i32 = 51;
205/// Store tiles uncompressed (`NOCOMPRESS`).
206pub const NOCOMPRESS: i32 = -1;
207
208/// No dither when quantizing floats (`NO_DITHER`).
209pub const NO_DITHER: i32 = -1;
210/// Subtractive dithering, zeros treated as data (`SUBTRACTIVE_DITHER_1`).
211pub const SUBTRACTIVE_DITHER_1: i32 = 1;
212/// Subtractive dithering, exact zeros preserved (`SUBTRACTIVE_DITHER_2`).
213pub const SUBTRACTIVE_DITHER_2: i32 = 2;
214
215/// Sentinel meaning "do not quantize floats" (`NO_QUANTIZE` in `imcompress.c`).
216pub const NO_QUANTIZE: f32 = 9999.0;
217
218/// HDU class.
219#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
220pub enum HduType {
221    Image = 0,
222    AsciiTable = 1,
223    BinaryTable = 2,
224}
225
226impl HduType {
227    /// CFITSIO `IMAGE_HDU` / `ASCII_TBL` / `BINARY_TBL` code.
228    #[must_use]
229    pub const fn code(self) -> i32 {
230        self as i32
231    }
232}
233
234/// Keyword classification (`ffgkcl`).
235#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
236#[repr(i32)]
237pub enum KeyClass {
238    Structure = TYP_STRUC_KEY,
239    Compressed = TYP_CMPRS_KEY,
240    Scaling = TYP_SCAL_KEY,
241    Null = TYP_NULL_KEY,
242    Dimension = TYP_DIM_KEY,
243    Range = TYP_RANG_KEY,
244    Unit = TYP_UNIT_KEY,
245    Display = TYP_DISP_KEY,
246    HduId = TYP_HDUID_KEY,
247    Checksum = TYP_CKSUM_KEY,
248    Wcs = TYP_WCS_KEY,
249    Refsys = TYP_REFSYS_KEY,
250    Comment = TYP_COMM_KEY,
251    Continue = TYP_CONT_KEY,
252    User = TYP_USER_KEY,
253}
254
255impl KeyClass {
256    /// CFITSIO `TYP_*_KEY` integer.
257    #[must_use]
258    pub const fn code(self) -> i32 {
259        self as i32
260    }
261
262    /// Reconstruct from a CFITSIO class code. Unknown codes become [`KeyClass::User`].
263    #[must_use]
264    pub const fn from_code(code: i32) -> Self {
265        match code {
266            TYP_STRUC_KEY => Self::Structure,
267            TYP_CMPRS_KEY => Self::Compressed,
268            TYP_SCAL_KEY => Self::Scaling,
269            TYP_NULL_KEY => Self::Null,
270            TYP_DIM_KEY => Self::Dimension,
271            TYP_RANG_KEY => Self::Range,
272            TYP_UNIT_KEY => Self::Unit,
273            TYP_DISP_KEY => Self::Display,
274            TYP_HDUID_KEY => Self::HduId,
275            TYP_CKSUM_KEY => Self::Checksum,
276            TYP_WCS_KEY => Self::Wcs,
277            TYP_REFSYS_KEY => Self::Refsys,
278            TYP_COMM_KEY => Self::Comment,
279            TYP_CONT_KEY => Self::Continue,
280            _ => Self::User,
281        }
282    }
283}