blob: f06a744e1a0b436837a717f0c8bc74fb3f80e175 [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +00001/*
2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3% %
4% %
5% %
6% FFFFF IIIII TTTTT SSSSS %
7% F I T SS %
8% FFF I T SSS %
9% F I T SS %
10% F IIIII T SSSSS %
11% %
12% %
13% Read/Write Flexible Image Transport System Images. %
14% %
15% Software Design %
cristyde984cd2013-12-01 14:49:27 +000016% Cristy %
cristy3ed852e2009-09-05 21:47:34 +000017% July 1992 %
18% %
19% %
cristyfe676ee2013-11-18 13:03:38 +000020% Copyright 1999-2014 ImageMagick Studio LLC, a non-profit organization %
cristy3ed852e2009-09-05 21:47:34 +000021% dedicated to making software imaging solutions freely available. %
22% %
23% You may not use this file except in compliance with the License. You may %
24% obtain a copy of the License at %
25% %
26% http://www.imagemagick.org/script/license.php %
27% %
28% Unless required by applicable law or agreed to in writing, software %
29% distributed under the License is distributed on an "AS IS" BASIS, %
30% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. %
31% See the License for the specific language governing permissions and %
32% limitations under the License. %
33% %
34%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
35%
36%
37*/
38
39/*
40 Include declarations.
41*/
cristy4c08aed2011-07-01 19:47:50 +000042#include "MagickCore/studio.h"
43#include "MagickCore/attribute.h"
44#include "MagickCore/blob.h"
45#include "MagickCore/blob-private.h"
46#include "MagickCore/cache.h"
47#include "MagickCore/color-private.h"
48#include "MagickCore/colorspace.h"
cristy510d06a2011-07-06 23:43:54 +000049#include "MagickCore/colorspace-private.h"
cristy4c08aed2011-07-01 19:47:50 +000050#include "MagickCore/constitute.h"
51#include "MagickCore/exception.h"
52#include "MagickCore/exception-private.h"
53#include "MagickCore/image.h"
54#include "MagickCore/image-private.h"
55#include "MagickCore/list.h"
56#include "MagickCore/magick.h"
57#include "MagickCore/memory_.h"
58#include "MagickCore/module.h"
59#include "MagickCore/monitor.h"
60#include "MagickCore/monitor-private.h"
61#include "MagickCore/pixel-accessor.h"
62#include "MagickCore/property.h"
63#include "MagickCore/quantum-private.h"
64#include "MagickCore/static.h"
65#include "MagickCore/statistic.h"
66#include "MagickCore/string_.h"
67#include "MagickCore/string-private.h"
68#include "MagickCore/module.h"
cristy3ed852e2009-09-05 21:47:34 +000069
70/*
71 Forward declarations.
72*/
73#define FITSBlocksize 2880UL
74
75/*
76 Forward declarations.
77*/
78static MagickBooleanType
cristy1e178e72011-08-28 19:44:34 +000079 WriteFITSImage(const ImageInfo *,Image *,ExceptionInfo *);
cristy3ed852e2009-09-05 21:47:34 +000080
81/*
82%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
83% %
84% %
85% %
86% I s F I T S %
87% %
88% %
89% %
90%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
91%
92% IsFITS() returns MagickTrue if the image format type, identified by the
93% magick string, is FITS.
94%
95% The format of the IsFITS method is:
96%
97% MagickBooleanType IsFITS(const unsigned char *magick,const size_t length)
98%
99% A description of each parameter follows:
100%
101% o magick: compare image format pattern against these bytes.
102%
103% o length: Specifies the length of the magick string.
104%
105*/
106static MagickBooleanType IsFITS(const unsigned char *magick,const size_t length)
107{
108 if (length < 6)
109 return(MagickFalse);
110 if (LocaleNCompare((const char *) magick,"IT0",3) == 0)
111 return(MagickTrue);
112 if (LocaleNCompare((const char *) magick,"SIMPLE",6) == 0)
113 return(MagickTrue);
114 return(MagickFalse);
115}
116
117/*
118%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
119% %
120% %
121% %
122% R e a d F I T S I m a g e %
123% %
124% %
125% %
126%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
127%
128% ReadFITSImage() reads a FITS image file and returns it. It allocates the
129% memory necessary for the new Image structure and returns a pointer to the
130% new image.
131%
132% The format of the ReadFITSImage method is:
133%
134% Image *ReadFITSImage(const ImageInfo *image_info,
135% ExceptionInfo *exception)
136%
137% A description of each parameter follows:
138%
139% o image_info: the image info.
140%
141% o exception: return any errors or warnings in this structure.
142%
143*/
144
145static inline double GetFITSPixel(Image *image,int bits_per_pixel)
146{
147 switch (image->depth >> 3)
148 {
149 case 1:
150 return((double) ReadBlobByte(image));
151 case 2:
152 return((double) ((short) ReadBlobShort(image)));
153 case 4:
154 {
155 if (bits_per_pixel > 0)
cristy6cff05d2010-09-02 11:22:46 +0000156 return((double) ((int) ReadBlobLong(image)));
cristy3ed852e2009-09-05 21:47:34 +0000157 return((double) ReadBlobFloat(image));
158 }
159 case 8:
160 {
161 if (bits_per_pixel > 0)
162 return((double) ((MagickOffsetType) ReadBlobLongLong(image)));
163 }
164 default:
165 break;
166 }
167 return(ReadBlobDouble(image));
168}
169
170static void GetFITSPixelExtrema(Image *image,const int bits_per_pixel,
171 double *minima,double *maxima)
172{
173 double
174 pixel;
175
176 MagickOffsetType
177 offset;
178
179 MagickSizeType
180 number_pixels;
181
182 register MagickOffsetType
183 i;
184
185 offset=TellBlob(image);
186 number_pixels=(MagickSizeType) image->columns*image->rows;
187 *minima=GetFITSPixel(image,bits_per_pixel);
188 *maxima=(*minima);
189 for (i=1; i < (MagickOffsetType) number_pixels; i++)
190 {
191 pixel=GetFITSPixel(image,bits_per_pixel);
192 if (pixel < *minima)
193 *minima=pixel;
194 if (pixel > *maxima)
195 *maxima=pixel;
196 }
197 (void) SeekBlob(image,offset,SEEK_SET);
198}
199
cristybb503372010-05-27 20:51:26 +0000200static inline double GetFITSPixelRange(const size_t depth)
cristy3ed852e2009-09-05 21:47:34 +0000201{
202 return((double) ((MagickOffsetType) GetQuantumRange(depth)));
203}
204
205static void SetFITSUnsignedPixels(const size_t length,
cristyf84dc8e2013-02-02 16:46:26 +0000206 const size_t bits_per_pixel,const EndianType endian,unsigned char *pixels)
cristy3ed852e2009-09-05 21:47:34 +0000207{
cristybb503372010-05-27 20:51:26 +0000208 register ssize_t
cristy3ed852e2009-09-05 21:47:34 +0000209 i;
210
cristyf84dc8e2013-02-02 16:46:26 +0000211 if (endian != MSBEndian)
212 pixels+=(bits_per_pixel >> 3)-1;
cristybb503372010-05-27 20:51:26 +0000213 for (i=0; i < (ssize_t) length; i++)
cristy3ed852e2009-09-05 21:47:34 +0000214 {
215 *pixels^=0x80;
216 pixels+=bits_per_pixel >> 3;
217 }
218}
219
220static Image *ReadFITSImage(const ImageInfo *image_info,
221 ExceptionInfo *exception)
222{
223 typedef struct _FITSInfo
224 {
225 MagickBooleanType
226 extend,
227 simple;
228
229 int
230 bits_per_pixel,
231 columns,
232 rows,
233 number_axes,
234 number_planes;
235
236 double
237 min_data,
238 max_data,
239 zero,
240 scale;
241
242 EndianType
243 endian;
244 } FITSInfo;
245
246 char
247 *comment,
248 keyword[9],
249 property[MaxTextExtent],
250 value[73];
251
252 double
253 pixel,
254 scale;
255
256 FITSInfo
257 fits_info;
258
259 Image
260 *image;
261
262 int
263 c;
264
cristy3ed852e2009-09-05 21:47:34 +0000265 MagickBooleanType
266 status;
267
268 MagickSizeType
269 number_pixels;
270
cristybb503372010-05-27 20:51:26 +0000271 register ssize_t
cristy3ed852e2009-09-05 21:47:34 +0000272 i,
273 x;
274
cristy4c08aed2011-07-01 19:47:50 +0000275 register Quantum
cristy3ed852e2009-09-05 21:47:34 +0000276 *q;
277
278 ssize_t
cristy202de442011-04-24 18:19:07 +0000279 count,
280 scene,
281 y;
cristy3ed852e2009-09-05 21:47:34 +0000282
283 /*
284 Open image file.
285 */
286 assert(image_info != (const ImageInfo *) NULL);
287 assert(image_info->signature == MagickSignature);
288 if (image_info->debug != MagickFalse)
289 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
290 image_info->filename);
291 assert(exception != (ExceptionInfo *) NULL);
292 assert(exception->signature == MagickSignature);
cristy9950d572011-10-01 18:22:35 +0000293 image=AcquireImage(image_info,exception);
cristy3ed852e2009-09-05 21:47:34 +0000294 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
295 if (status == MagickFalse)
296 {
297 image=DestroyImageList(image);
298 return((Image *) NULL);
299 }
300 /*
301 Initialize image header.
302 */
303 (void) ResetMagickMemory(&fits_info,0,sizeof(fits_info));
304 fits_info.extend=MagickFalse;
305 fits_info.simple=MagickFalse;
306 fits_info.bits_per_pixel=8;
307 fits_info.columns=1;
308 fits_info.rows=1;
309 fits_info.rows=1;
310 fits_info.number_planes=1;
311 fits_info.min_data=0.0;
312 fits_info.max_data=0.0;
313 fits_info.zero=0.0;
314 fits_info.scale=1.0;
315 fits_info.endian=MSBEndian;
316 /*
317 Decode image header.
318 */
319 for (comment=(char *) NULL; EOFBlob(image) == MagickFalse; )
320 {
321 for ( ; EOFBlob(image) == MagickFalse; )
322 {
323 register char
324 *p;
325
326 count=ReadBlob(image,8,(unsigned char *) keyword);
327 if (count != 8)
328 break;
329 for (i=0; i < 8; i++)
330 {
331 if (isspace((int) ((unsigned char) keyword[i])) != 0)
332 break;
cristy466802f2010-02-24 14:18:37 +0000333 keyword[i]=tolower((int) ((unsigned char) keyword[i]));
cristy3ed852e2009-09-05 21:47:34 +0000334 }
335 keyword[i]='\0';
336 count=ReadBlob(image,72,(unsigned char *) value);
337 if (count != 72)
338 break;
339 value[72]='\0';
340 p=value;
341 if (*p == '=')
342 {
343 p+=2;
344 while (isspace((int) ((unsigned char) *p)) != 0)
345 p++;
346 }
347 if (LocaleCompare(keyword,"end") == 0)
348 break;
349 if (LocaleCompare(keyword,"extend") == 0)
350 fits_info.extend=(*p == 'T') || (*p == 't') ? MagickTrue : MagickFalse;
351 if (LocaleCompare(keyword,"simple") == 0)
352 fits_info.simple=(*p == 'T') || (*p == 't') ? MagickTrue : MagickFalse;
353 if (LocaleCompare(keyword,"bitpix") == 0)
cristyf2f27272009-12-17 14:48:46 +0000354 fits_info.bits_per_pixel=StringToLong(p);
cristy3ed852e2009-09-05 21:47:34 +0000355 if (LocaleCompare(keyword,"naxis") == 0)
cristyf2f27272009-12-17 14:48:46 +0000356 fits_info.number_axes=StringToLong(p);
cristy3ed852e2009-09-05 21:47:34 +0000357 if (LocaleCompare(keyword,"naxis1") == 0)
cristyf2f27272009-12-17 14:48:46 +0000358 fits_info.columns=StringToLong(p);
cristy3ed852e2009-09-05 21:47:34 +0000359 if (LocaleCompare(keyword,"naxis2") == 0)
cristyf2f27272009-12-17 14:48:46 +0000360 fits_info.rows=StringToLong(p);
cristy3ed852e2009-09-05 21:47:34 +0000361 if (LocaleCompare(keyword,"naxis3") == 0)
cristyf2f27272009-12-17 14:48:46 +0000362 fits_info.number_planes=StringToLong(p);
cristy3ed852e2009-09-05 21:47:34 +0000363 if (LocaleCompare(keyword,"datamax") == 0)
cristydbdd0e32011-11-04 23:29:40 +0000364 fits_info.max_data=StringToDouble(p,(char **) NULL);
cristy3ed852e2009-09-05 21:47:34 +0000365 if (LocaleCompare(keyword,"datamin") == 0)
cristydbdd0e32011-11-04 23:29:40 +0000366 fits_info.min_data=StringToDouble(p,(char **) NULL);
cristy3ed852e2009-09-05 21:47:34 +0000367 if (LocaleCompare(keyword,"bzero") == 0)
cristydbdd0e32011-11-04 23:29:40 +0000368 fits_info.zero=StringToDouble(p,(char **) NULL);
cristy3ed852e2009-09-05 21:47:34 +0000369 if (LocaleCompare(keyword,"bscale") == 0)
cristydbdd0e32011-11-04 23:29:40 +0000370 fits_info.scale=StringToDouble(p,(char **) NULL);
cristy3ed852e2009-09-05 21:47:34 +0000371 if (LocaleCompare(keyword,"comment") == 0)
372 {
373 if (comment == (char *) NULL)
374 comment=ConstantString(p);
375 else
376 (void) ConcatenateString(&comment,p);
377 }
378 if (LocaleCompare(keyword,"xendian") == 0)
379 {
380 if (LocaleNCompare(p,"big",3) == 0)
381 fits_info.endian=MSBEndian;
382 else
383 fits_info.endian=LSBEndian;
384 }
cristyb51dff52011-05-19 16:55:47 +0000385 (void) FormatLocaleString(property,MaxTextExtent,"fits:%s",keyword);
cristyd15e6592011-10-15 00:13:06 +0000386 (void) SetImageProperty(image,property,p,exception);
cristy3ed852e2009-09-05 21:47:34 +0000387 }
388 c=0;
389 while (((TellBlob(image) % FITSBlocksize) != 0) && (c != EOF))
390 c=ReadBlobByte(image);
391 if (fits_info.extend == MagickFalse)
392 break;
393 number_pixels=(MagickSizeType) fits_info.columns*fits_info.rows;
394 if ((fits_info.simple != MagickFalse) && (fits_info.number_axes >= 1) &&
395 (fits_info.number_axes <= 4) && (number_pixels != 0))
396 break;
397 }
398 /*
399 Verify that required image information is defined.
400 */
401 if (comment != (char *) NULL)
402 {
cristyd15e6592011-10-15 00:13:06 +0000403 (void) SetImageProperty(image,"comment",comment,exception);
cristy3ed852e2009-09-05 21:47:34 +0000404 comment=DestroyString(comment);
405 }
406 if (EOFBlob(image) != MagickFalse)
407 ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
408 image->filename);
409 number_pixels=(MagickSizeType) fits_info.columns*fits_info.rows;
410 if ((fits_info.simple == MagickFalse) || (fits_info.number_axes < 1) ||
411 (fits_info.number_axes > 4) || (number_pixels == 0))
412 ThrowReaderException(CorruptImageError,"ImageTypeNotSupported");
cristybb503372010-05-27 20:51:26 +0000413 for (scene=0; scene < (ssize_t) fits_info.number_planes; scene++)
cristy3ed852e2009-09-05 21:47:34 +0000414 {
cristybb503372010-05-27 20:51:26 +0000415 image->columns=(size_t) fits_info.columns;
416 image->rows=(size_t) fits_info.rows;
417 image->depth=(size_t) (fits_info.bits_per_pixel < 0 ? -1 : 1)*
cristy3ed852e2009-09-05 21:47:34 +0000418 fits_info.bits_per_pixel;
419 image->endian=fits_info.endian;
cristybb503372010-05-27 20:51:26 +0000420 image->scene=(size_t) scene;
cristy3ed852e2009-09-05 21:47:34 +0000421 if ((image_info->ping != MagickFalse) && (image_info->number_scenes != 0))
422 if (image->scene >= (image_info->scene+image_info->number_scenes-1))
423 break;
424 /*
425 Initialize image structure.
426 */
cristyd8b39812013-02-02 02:12:57 +0000427 (void) SetImageColorspace(image,GRAYColorspace,exception);
428 if ((fits_info.min_data == 0.0) && (fits_info.max_data == 0.0))
cristy3ed852e2009-09-05 21:47:34 +0000429 {
cristy3f6782c2013-02-06 01:33:50 +0000430 if (fits_info.zero == 0.0)
cristyd8b39812013-02-02 02:12:57 +0000431 GetFITSPixelExtrema(image,fits_info.bits_per_pixel,
432 &fits_info.min_data,&fits_info.max_data);
433 else
cristybb503372010-05-27 20:51:26 +0000434 fits_info.max_data=GetFITSPixelRange((size_t)
cristy3ed852e2009-09-05 21:47:34 +0000435 fits_info.bits_per_pixel);
436 }
437 else
cristyd8b39812013-02-02 02:12:57 +0000438 fits_info.max_data=GetFITSPixelRange((size_t) fits_info.bits_per_pixel);
cristy3ed852e2009-09-05 21:47:34 +0000439 /*
440 Convert FITS pixels to pixel packets.
441 */
cristyd8b39812013-02-02 02:12:57 +0000442 scale=QuantumRange/(fits_info.max_data-fits_info.min_data);
cristybb503372010-05-27 20:51:26 +0000443 for (y=(ssize_t) image->rows-1; y >= 0; y--)
cristy3ed852e2009-09-05 21:47:34 +0000444 {
445 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
cristyacd2ed22011-08-30 01:44:23 +0000446 if (q == (Quantum *) NULL)
cristy3ed852e2009-09-05 21:47:34 +0000447 break;
cristybb503372010-05-27 20:51:26 +0000448 for (x=0; x < (ssize_t) image->columns; x++)
cristy3ed852e2009-09-05 21:47:34 +0000449 {
450 pixel=GetFITSPixel(image,fits_info.bits_per_pixel);
cristy163d6782013-01-26 13:54:54 +0000451 if ((image->depth == 16) || (image->depth == 32) ||
cristy9dcadc52013-01-26 13:53:22 +0000452 (image->depth == 64))
cristyf84dc8e2013-02-02 16:46:26 +0000453 SetFITSUnsignedPixels(1,image->depth,image->endian,
454 (unsigned char *) &pixel);
cristy12142882012-06-17 00:52:29 +0000455 SetPixelGray(image,ClampToQuantum(scale*(fits_info.scale*(pixel-
456 fits_info.min_data)+fits_info.zero)),q);
cristyed231572011-07-14 02:18:59 +0000457 q+=GetPixelChannels(image);
cristy3ed852e2009-09-05 21:47:34 +0000458 }
459 if (SyncAuthenticPixels(image,exception) == MagickFalse)
460 break;
461 if (image->previous == (Image *) NULL)
462 {
cristycee97112010-05-28 00:44:52 +0000463 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
cristy4c08aed2011-07-01 19:47:50 +0000464 image->rows);
cristy3ed852e2009-09-05 21:47:34 +0000465 if (status == MagickFalse)
466 break;
467 }
468 }
469 if (EOFBlob(image) != MagickFalse)
470 {
471 ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
472 image->filename);
473 break;
474 }
475 /*
476 Proceed to next image.
477 */
478 if (image_info->number_scenes != 0)
479 if (image->scene >= (image_info->scene+image_info->number_scenes-1))
480 break;
cristybb503372010-05-27 20:51:26 +0000481 if (scene < (ssize_t) (fits_info.number_planes-1))
cristy3ed852e2009-09-05 21:47:34 +0000482 {
483 /*
484 Allocate next image structure.
485 */
cristy9950d572011-10-01 18:22:35 +0000486 AcquireNextImage(image_info,image,exception);
cristy3ed852e2009-09-05 21:47:34 +0000487 if (GetNextImageInList(image) == (Image *) NULL)
488 {
489 image=DestroyImageList(image);
490 return((Image *) NULL);
491 }
492 image=SyncNextImageInList(image);
493 status=SetImageProgress(image,LoadImagesTag,TellBlob(image),
494 GetBlobSize(image));
495 if (status == MagickFalse)
496 break;
497 }
498 }
499 (void) CloseBlob(image);
500 return(GetFirstImageInList(image));
501}
502
503/*
504%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
505% %
506% %
507% %
508% R e g i s t e r F I T S I m a g e %
509% %
510% %
511% %
512%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
513%
514% RegisterFITSImage() adds attributes for the FITS image format to
515% the list of supported formats. The attributes include the image format
516% tag, a method to read and/or write the format, whether the format
517% supports the saving of more than one frame to the same file or blob,
518% whether the format supports native in-memory I/O, and a brief
519% description of the format.
520%
521% The format of the RegisterFITSImage method is:
522%
cristybb503372010-05-27 20:51:26 +0000523% size_t RegisterFITSImage(void)
cristy3ed852e2009-09-05 21:47:34 +0000524%
525*/
cristybb503372010-05-27 20:51:26 +0000526ModuleExport size_t RegisterFITSImage(void)
cristy3ed852e2009-09-05 21:47:34 +0000527{
528 MagickInfo
529 *entry;
530
531 entry=SetMagickInfo("FITS");
532 entry->decoder=(DecodeImageHandler *) ReadFITSImage;
533 entry->encoder=(EncodeImageHandler *) WriteFITSImage;
534 entry->magick=(IsImageFormatHandler *) IsFITS;
535 entry->adjoin=MagickFalse;
536 entry->seekable_stream=MagickTrue;
537 entry->description=ConstantString("Flexible Image Transport System");
538 entry->module=ConstantString("FITS");
539 (void) RegisterMagickInfo(entry);
540 entry=SetMagickInfo("FTS");
541 entry->decoder=(DecodeImageHandler *) ReadFITSImage;
542 entry->encoder=(EncodeImageHandler *) WriteFITSImage;
543 entry->magick=(IsImageFormatHandler *) IsFITS;
544 entry->adjoin=MagickFalse;
545 entry->seekable_stream=MagickTrue;
546 entry->description=ConstantString("Flexible Image Transport System");
547 entry->module=ConstantString("FTS");
548 (void) RegisterMagickInfo(entry);
549 return(MagickImageCoderSignature);
550}
551
552/*
553%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
554% %
555% %
556% %
557% U n r e g i s t e r F I T S I m a g e %
558% %
559% %
560% %
561%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
562%
563% UnregisterFITSImage() removes format registrations made by the
564% FITS module from the list of supported formats.
565%
566% The format of the UnregisterFITSImage method is:
567%
568% UnregisterFITSImage(void)
569%
570*/
571ModuleExport void UnregisterFITSImage(void)
572{
573 (void) UnregisterMagickInfo("FITS");
574 (void) UnregisterMagickInfo("FTS");
575}
576
577/*
578%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
579% %
580% %
581% %
582% W r i t e F I T S I m a g e %
583% %
584% %
585% %
586%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
587%
588% WriteFITSImage() writes a Flexible Image Transport System image to a
589% file as gray scale intensities [0..255].
590%
591% The format of the WriteFITSImage method is:
592%
593% MagickBooleanType WriteFITSImage(const ImageInfo *image_info,
cristy1e178e72011-08-28 19:44:34 +0000594% Image *image,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000595%
596% A description of each parameter follows.
597%
598% o image_info: the image info.
599%
600% o image: The image.
601%
cristy1e178e72011-08-28 19:44:34 +0000602% o exception: return any errors or warnings in this structure.
603%
cristy3ed852e2009-09-05 21:47:34 +0000604*/
605static MagickBooleanType WriteFITSImage(const ImageInfo *image_info,
cristy1e178e72011-08-28 19:44:34 +0000606 Image *image,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000607{
608 char
609 header[FITSBlocksize],
610 *fits_info;
611
cristy3ed852e2009-09-05 21:47:34 +0000612 MagickBooleanType
613 status;
614
615 QuantumInfo
616 *quantum_info;
617
cristy4c08aed2011-07-01 19:47:50 +0000618 register const Quantum
cristy3ed852e2009-09-05 21:47:34 +0000619 *p;
620
621 size_t
622 length;
623
624 ssize_t
625 count,
cristy2692d592010-11-01 18:07:27 +0000626 offset,
627 y;
cristy3ed852e2009-09-05 21:47:34 +0000628
629 unsigned char
630 *pixels;
631
632 /*
633 Open output image file.
634 */
635 assert(image_info != (const ImageInfo *) NULL);
636 assert(image_info->signature == MagickSignature);
637 assert(image != (Image *) NULL);
638 assert(image->signature == MagickSignature);
639 if (image->debug != MagickFalse)
640 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
cristy3a37efd2011-08-28 20:31:03 +0000641 assert(exception != (ExceptionInfo *) NULL);
642 assert(exception->signature == MagickSignature);
cristy1e178e72011-08-28 19:44:34 +0000643 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
cristy3ed852e2009-09-05 21:47:34 +0000644 if (status == MagickFalse)
645 return(status);
cristy3d9f5ba2012-06-26 13:37:31 +0000646 if (IssRGBCompatibleColorspace(image->colorspace) == MagickFalse)
cristyd9ecd042012-06-17 18:26:12 +0000647 (void) TransformImageColorspace(image,sRGBColorspace,exception);
cristy3ed852e2009-09-05 21:47:34 +0000648 /*
649 Allocate image memory.
650 */
651 fits_info=(char *) AcquireQuantumMemory(FITSBlocksize,sizeof(*fits_info));
652 if (fits_info == (char *) NULL)
653 ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
654 (void) ResetMagickMemory(fits_info,' ',FITSBlocksize*sizeof(*fits_info));
655 /*
656 Initialize image header.
657 */
658 image->depth=GetImageQuantumDepth(image,MagickFalse);
cristy6ea44a92013-02-03 23:40:10 +0000659 image->endian=MSBEndian;
cristy3ed852e2009-09-05 21:47:34 +0000660 quantum_info=AcquireQuantumInfo((const ImageInfo *) NULL,image);
661 if (quantum_info == (QuantumInfo *) NULL)
662 ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
663 offset=0;
cristyb51dff52011-05-19 16:55:47 +0000664 (void) FormatLocaleString(header,FITSBlocksize,
cristy3ed852e2009-09-05 21:47:34 +0000665 "SIMPLE = T");
666 (void) strncpy(fits_info+offset,header,strlen(header));
667 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000668 (void) FormatLocaleString(header,FITSBlocksize,"BITPIX = %10ld",
cristyf2faecf2010-05-28 19:19:36 +0000669 (long) (quantum_info->format == FloatingPointQuantumFormat ? -1 : 1)*
670 image->depth);
cristy3ed852e2009-09-05 21:47:34 +0000671 (void) strncpy(fits_info+offset,header,strlen(header));
672 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000673 (void) FormatLocaleString(header,FITSBlocksize,"NAXIS = %10lu",
cristy1e178e72011-08-28 19:44:34 +0000674 IsImageGray(image,exception) != MagickFalse ? 2UL : 3UL);
cristy3ed852e2009-09-05 21:47:34 +0000675 (void) strncpy(fits_info+offset,header,strlen(header));
676 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000677 (void) FormatLocaleString(header,FITSBlocksize,"NAXIS1 = %10lu",
cristyf2faecf2010-05-28 19:19:36 +0000678 (unsigned long) image->columns);
cristy3ed852e2009-09-05 21:47:34 +0000679 (void) strncpy(fits_info+offset,header,strlen(header));
680 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000681 (void) FormatLocaleString(header,FITSBlocksize,"NAXIS2 = %10lu",
cristyf2faecf2010-05-28 19:19:36 +0000682 (unsigned long) image->rows);
cristy3ed852e2009-09-05 21:47:34 +0000683 (void) strncpy(fits_info+offset,header,strlen(header));
684 offset+=80;
cristy1e178e72011-08-28 19:44:34 +0000685 if (IsImageGray(image,exception) == MagickFalse)
cristyfcbcae82011-04-22 12:53:27 +0000686 {
cristyb51dff52011-05-19 16:55:47 +0000687 (void) FormatLocaleString(header,FITSBlocksize,
cristyfcbcae82011-04-22 12:53:27 +0000688 "NAXIS3 = %10lu",3UL);
689 (void) strncpy(fits_info+offset,header,strlen(header));
690 offset+=80;
691 }
cristyb51dff52011-05-19 16:55:47 +0000692 (void) FormatLocaleString(header,FITSBlocksize,"BSCALE = %E",1.0);
cristy3ed852e2009-09-05 21:47:34 +0000693 (void) strncpy(fits_info+offset,header,strlen(header));
694 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000695 (void) FormatLocaleString(header,FITSBlocksize,"BZERO = %E",
cristy3ec9e8d2013-01-30 16:29:51 +0000696 image->depth > 8 ? GetFITSPixelRange(image->depth)/2.0 : 0.0);
cristy3ed852e2009-09-05 21:47:34 +0000697 (void) strncpy(fits_info+offset,header,strlen(header));
698 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000699 (void) FormatLocaleString(header,FITSBlocksize,"DATAMAX = %E",
cristy3ed852e2009-09-05 21:47:34 +0000700 1.0*((MagickOffsetType) GetQuantumRange(image->depth)));
701 (void) strncpy(fits_info+offset,header,strlen(header));
702 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000703 (void) FormatLocaleString(header,FITSBlocksize,"DATAMIN = %E",0.0);
cristy3ed852e2009-09-05 21:47:34 +0000704 (void) strncpy(fits_info+offset,header,strlen(header));
705 offset+=80;
706 if (image->endian == LSBEndian)
707 {
cristyb51dff52011-05-19 16:55:47 +0000708 (void) FormatLocaleString(header,FITSBlocksize,"XENDIAN = 'SMALL'");
cristy3ed852e2009-09-05 21:47:34 +0000709 (void) strncpy(fits_info+offset,header,strlen(header));
710 offset+=80;
711 }
cristyb51dff52011-05-19 16:55:47 +0000712 (void) FormatLocaleString(header,FITSBlocksize,"HISTORY %.72s",
cristybb503372010-05-27 20:51:26 +0000713 GetMagickVersion((size_t *) NULL));
cristy3ed852e2009-09-05 21:47:34 +0000714 (void) strncpy(fits_info+offset,header,strlen(header));
715 offset+=80;
716 (void) strncpy(header,"END",FITSBlocksize);
717 (void) strncpy(fits_info+offset,header,strlen(header));
718 offset+=80;
719 (void) WriteBlob(image,FITSBlocksize,(unsigned char *) fits_info);
720 /*
721 Convert image to fits scale PseudoColor class.
722 */
723 pixels=GetQuantumPixels(quantum_info);
cristy1e178e72011-08-28 19:44:34 +0000724 if (IsImageGray(image,exception) != MagickFalse)
cristyfcbcae82011-04-22 12:53:27 +0000725 {
726 length=GetQuantumExtent(image,quantum_info,GrayQuantum);
727 for (y=(ssize_t) image->rows-1; y >= 0; y--)
728 {
cristy1e178e72011-08-28 19:44:34 +0000729 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
cristy4c08aed2011-07-01 19:47:50 +0000730 if (p == (const Quantum *) NULL)
cristyfcbcae82011-04-22 12:53:27 +0000731 break;
cristy4c08aed2011-07-01 19:47:50 +0000732 length=ExportQuantumPixels(image,(CacheView *) NULL,quantum_info,
cristy1e178e72011-08-28 19:44:34 +0000733 GrayQuantum,pixels,exception);
cristyfcbcae82011-04-22 12:53:27 +0000734 if (image->depth == 16)
cristyf84dc8e2013-02-02 16:46:26 +0000735 SetFITSUnsignedPixels(image->columns,image->depth,image->endian,
736 pixels);
cristyfcbcae82011-04-22 12:53:27 +0000737 if (((image->depth == 32) || (image->depth == 64)) &&
738 (quantum_info->format != FloatingPointQuantumFormat))
cristyf84dc8e2013-02-02 16:46:26 +0000739 SetFITSUnsignedPixels(image->columns,image->depth,image->endian,
740 pixels);
cristyfcbcae82011-04-22 12:53:27 +0000741 count=WriteBlob(image,length,pixels);
742 if (count != (ssize_t) length)
743 break;
744 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
745 image->rows);
746 if (status == MagickFalse)
747 break;
748 }
749 }
750 else
751 {
752 length=GetQuantumExtent(image,quantum_info,RedQuantum);
753 for (y=(ssize_t) image->rows-1; y >= 0; y--)
754 {
cristy1e178e72011-08-28 19:44:34 +0000755 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
cristy4c08aed2011-07-01 19:47:50 +0000756 if (p == (const Quantum *) NULL)
cristyfcbcae82011-04-22 12:53:27 +0000757 break;
cristy4c08aed2011-07-01 19:47:50 +0000758 length=ExportQuantumPixels(image,(CacheView *) NULL,quantum_info,
cristy1e178e72011-08-28 19:44:34 +0000759 RedQuantum,pixels,exception);
cristyfcbcae82011-04-22 12:53:27 +0000760 if (image->depth == 16)
cristyf84dc8e2013-02-02 16:46:26 +0000761 SetFITSUnsignedPixels(image->columns,image->depth,image->endian,
762 pixels);
cristyfcbcae82011-04-22 12:53:27 +0000763 if (((image->depth == 32) || (image->depth == 64)) &&
764 (quantum_info->format != FloatingPointQuantumFormat))
cristyf84dc8e2013-02-02 16:46:26 +0000765 SetFITSUnsignedPixels(image->columns,image->depth,image->endian,
766 pixels);
cristyfcbcae82011-04-22 12:53:27 +0000767 count=WriteBlob(image,length,pixels);
768 if (count != (ssize_t) length)
769 break;
770 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
771 image->rows);
772 if (status == MagickFalse)
773 break;
774 }
775 length=GetQuantumExtent(image,quantum_info,GreenQuantum);
776 for (y=(ssize_t) image->rows-1; y >= 0; y--)
777 {
cristy1e178e72011-08-28 19:44:34 +0000778 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
cristy4c08aed2011-07-01 19:47:50 +0000779 if (p == (const Quantum *) NULL)
cristyfcbcae82011-04-22 12:53:27 +0000780 break;
cristy4c08aed2011-07-01 19:47:50 +0000781 length=ExportQuantumPixels(image,(CacheView *) NULL,quantum_info,
cristy1e178e72011-08-28 19:44:34 +0000782 GreenQuantum,pixels,exception);
cristyfcbcae82011-04-22 12:53:27 +0000783 if (image->depth == 16)
cristyf84dc8e2013-02-02 16:46:26 +0000784 SetFITSUnsignedPixels(image->columns,image->depth,image->endian,
785 pixels);
cristyfcbcae82011-04-22 12:53:27 +0000786 if (((image->depth == 32) || (image->depth == 64)) &&
787 (quantum_info->format != FloatingPointQuantumFormat))
cristyf84dc8e2013-02-02 16:46:26 +0000788 SetFITSUnsignedPixels(image->columns,image->depth,image->endian,
789 pixels);
cristyfcbcae82011-04-22 12:53:27 +0000790 count=WriteBlob(image,length,pixels);
791 if (count != (ssize_t) length)
792 break;
793 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
794 image->rows);
795 if (status == MagickFalse)
796 break;
797 }
798 length=GetQuantumExtent(image,quantum_info,BlueQuantum);
799 for (y=(ssize_t) image->rows-1; y >= 0; y--)
800 {
cristy1e178e72011-08-28 19:44:34 +0000801 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
cristy4c08aed2011-07-01 19:47:50 +0000802 if (p == (const Quantum *) NULL)
cristyfcbcae82011-04-22 12:53:27 +0000803 break;
cristy4c08aed2011-07-01 19:47:50 +0000804 length=ExportQuantumPixels(image,(CacheView *) NULL,quantum_info,
cristy1e178e72011-08-28 19:44:34 +0000805 BlueQuantum,pixels,exception);
cristyfcbcae82011-04-22 12:53:27 +0000806 if (image->depth == 16)
cristyf84dc8e2013-02-02 16:46:26 +0000807 SetFITSUnsignedPixels(image->columns,image->depth,image->endian,
808 pixels);
cristyfcbcae82011-04-22 12:53:27 +0000809 if (((image->depth == 32) || (image->depth == 64)) &&
810 (quantum_info->format != FloatingPointQuantumFormat))
cristyf84dc8e2013-02-02 16:46:26 +0000811 SetFITSUnsignedPixels(image->columns,image->depth,image->endian,
812 pixels);
cristyfcbcae82011-04-22 12:53:27 +0000813 count=WriteBlob(image,length,pixels);
814 if (count != (ssize_t) length)
815 break;
816 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
817 image->rows);
818 if (status == MagickFalse)
819 break;
820 }
821 }
cristy3ed852e2009-09-05 21:47:34 +0000822 quantum_info=DestroyQuantumInfo(quantum_info);
823 length=(size_t) (FITSBlocksize-TellBlob(image) % FITSBlocksize);
824 if (length != 0)
825 {
826 (void) ResetMagickMemory(fits_info,0,length*sizeof(*fits_info));
827 (void) WriteBlob(image,length,(unsigned char *) fits_info);
828 }
829 fits_info=DestroyString(fits_info);
830 (void) CloseBlob(image);
831 return(MagickTrue);
832}