blob: b631f75757f20f937dbf53989954db599b45c95c [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 %
16% John Cristy %
17% July 1992 %
18% %
19% %
cristy7e41fe82010-12-04 23:12:08 +000020% Copyright 1999-2011 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,
cristybb503372010-05-27 20:51:26 +0000206 const size_t bits_per_pixel,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
cristybb503372010-05-27 20:51:26 +0000211 for (i=0; i < (ssize_t) length; i++)
cristy3ed852e2009-09-05 21:47:34 +0000212 {
213 *pixels^=0x80;
214 pixels+=bits_per_pixel >> 3;
215 }
216}
217
218static Image *ReadFITSImage(const ImageInfo *image_info,
219 ExceptionInfo *exception)
220{
221 typedef struct _FITSInfo
222 {
223 MagickBooleanType
224 extend,
225 simple;
226
227 int
228 bits_per_pixel,
229 columns,
230 rows,
231 number_axes,
232 number_planes;
233
234 double
235 min_data,
236 max_data,
237 zero,
238 scale;
239
240 EndianType
241 endian;
242 } FITSInfo;
243
244 char
245 *comment,
246 keyword[9],
247 property[MaxTextExtent],
248 value[73];
249
250 double
251 pixel,
252 scale;
253
254 FITSInfo
255 fits_info;
256
257 Image
258 *image;
259
260 int
261 c;
262
cristy3ed852e2009-09-05 21:47:34 +0000263 MagickBooleanType
264 status;
265
266 MagickSizeType
267 number_pixels;
268
cristybb503372010-05-27 20:51:26 +0000269 register ssize_t
cristy3ed852e2009-09-05 21:47:34 +0000270 i,
271 x;
272
cristy4c08aed2011-07-01 19:47:50 +0000273 register Quantum
cristy3ed852e2009-09-05 21:47:34 +0000274 *q;
275
276 ssize_t
cristy202de442011-04-24 18:19:07 +0000277 count,
278 scene,
279 y;
cristy3ed852e2009-09-05 21:47:34 +0000280
281 /*
282 Open image file.
283 */
284 assert(image_info != (const ImageInfo *) NULL);
285 assert(image_info->signature == MagickSignature);
286 if (image_info->debug != MagickFalse)
287 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
288 image_info->filename);
289 assert(exception != (ExceptionInfo *) NULL);
290 assert(exception->signature == MagickSignature);
cristy9950d572011-10-01 18:22:35 +0000291 image=AcquireImage(image_info,exception);
cristy3ed852e2009-09-05 21:47:34 +0000292 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
293 if (status == MagickFalse)
294 {
295 image=DestroyImageList(image);
296 return((Image *) NULL);
297 }
298 /*
299 Initialize image header.
300 */
301 (void) ResetMagickMemory(&fits_info,0,sizeof(fits_info));
302 fits_info.extend=MagickFalse;
303 fits_info.simple=MagickFalse;
304 fits_info.bits_per_pixel=8;
305 fits_info.columns=1;
306 fits_info.rows=1;
307 fits_info.rows=1;
308 fits_info.number_planes=1;
309 fits_info.min_data=0.0;
310 fits_info.max_data=0.0;
311 fits_info.zero=0.0;
312 fits_info.scale=1.0;
313 fits_info.endian=MSBEndian;
314 /*
315 Decode image header.
316 */
317 for (comment=(char *) NULL; EOFBlob(image) == MagickFalse; )
318 {
319 for ( ; EOFBlob(image) == MagickFalse; )
320 {
321 register char
322 *p;
323
324 count=ReadBlob(image,8,(unsigned char *) keyword);
325 if (count != 8)
326 break;
327 for (i=0; i < 8; i++)
328 {
329 if (isspace((int) ((unsigned char) keyword[i])) != 0)
330 break;
cristy466802f2010-02-24 14:18:37 +0000331 keyword[i]=tolower((int) ((unsigned char) keyword[i]));
cristy3ed852e2009-09-05 21:47:34 +0000332 }
333 keyword[i]='\0';
334 count=ReadBlob(image,72,(unsigned char *) value);
335 if (count != 72)
336 break;
337 value[72]='\0';
338 p=value;
339 if (*p == '=')
340 {
341 p+=2;
342 while (isspace((int) ((unsigned char) *p)) != 0)
343 p++;
344 }
345 if (LocaleCompare(keyword,"end") == 0)
346 break;
347 if (LocaleCompare(keyword,"extend") == 0)
348 fits_info.extend=(*p == 'T') || (*p == 't') ? MagickTrue : MagickFalse;
349 if (LocaleCompare(keyword,"simple") == 0)
350 fits_info.simple=(*p == 'T') || (*p == 't') ? MagickTrue : MagickFalse;
351 if (LocaleCompare(keyword,"bitpix") == 0)
cristyf2f27272009-12-17 14:48:46 +0000352 fits_info.bits_per_pixel=StringToLong(p);
cristy3ed852e2009-09-05 21:47:34 +0000353 if (LocaleCompare(keyword,"naxis") == 0)
cristyf2f27272009-12-17 14:48:46 +0000354 fits_info.number_axes=StringToLong(p);
cristy3ed852e2009-09-05 21:47:34 +0000355 if (LocaleCompare(keyword,"naxis1") == 0)
cristyf2f27272009-12-17 14:48:46 +0000356 fits_info.columns=StringToLong(p);
cristy3ed852e2009-09-05 21:47:34 +0000357 if (LocaleCompare(keyword,"naxis2") == 0)
cristyf2f27272009-12-17 14:48:46 +0000358 fits_info.rows=StringToLong(p);
cristy3ed852e2009-09-05 21:47:34 +0000359 if (LocaleCompare(keyword,"naxis3") == 0)
cristyf2f27272009-12-17 14:48:46 +0000360 fits_info.number_planes=StringToLong(p);
cristy3ed852e2009-09-05 21:47:34 +0000361 if (LocaleCompare(keyword,"datamax") == 0)
cristydbdd0e32011-11-04 23:29:40 +0000362 fits_info.max_data=StringToDouble(p,(char **) NULL);
cristy3ed852e2009-09-05 21:47:34 +0000363 if (LocaleCompare(keyword,"datamin") == 0)
cristydbdd0e32011-11-04 23:29:40 +0000364 fits_info.min_data=StringToDouble(p,(char **) NULL);
cristy3ed852e2009-09-05 21:47:34 +0000365 if (LocaleCompare(keyword,"bzero") == 0)
cristydbdd0e32011-11-04 23:29:40 +0000366 fits_info.zero=StringToDouble(p,(char **) NULL);
cristy3ed852e2009-09-05 21:47:34 +0000367 if (LocaleCompare(keyword,"bscale") == 0)
cristydbdd0e32011-11-04 23:29:40 +0000368 fits_info.scale=StringToDouble(p,(char **) NULL);
cristy3ed852e2009-09-05 21:47:34 +0000369 if (LocaleCompare(keyword,"comment") == 0)
370 {
371 if (comment == (char *) NULL)
372 comment=ConstantString(p);
373 else
374 (void) ConcatenateString(&comment,p);
375 }
376 if (LocaleCompare(keyword,"xendian") == 0)
377 {
378 if (LocaleNCompare(p,"big",3) == 0)
379 fits_info.endian=MSBEndian;
380 else
381 fits_info.endian=LSBEndian;
382 }
cristyb51dff52011-05-19 16:55:47 +0000383 (void) FormatLocaleString(property,MaxTextExtent,"fits:%s",keyword);
cristyd15e6592011-10-15 00:13:06 +0000384 (void) SetImageProperty(image,property,p,exception);
cristy3ed852e2009-09-05 21:47:34 +0000385 }
386 c=0;
387 while (((TellBlob(image) % FITSBlocksize) != 0) && (c != EOF))
388 c=ReadBlobByte(image);
389 if (fits_info.extend == MagickFalse)
390 break;
391 number_pixels=(MagickSizeType) fits_info.columns*fits_info.rows;
392 if ((fits_info.simple != MagickFalse) && (fits_info.number_axes >= 1) &&
393 (fits_info.number_axes <= 4) && (number_pixels != 0))
394 break;
395 }
396 /*
397 Verify that required image information is defined.
398 */
399 if (comment != (char *) NULL)
400 {
cristyd15e6592011-10-15 00:13:06 +0000401 (void) SetImageProperty(image,"comment",comment,exception);
cristy3ed852e2009-09-05 21:47:34 +0000402 comment=DestroyString(comment);
403 }
404 if (EOFBlob(image) != MagickFalse)
405 ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
406 image->filename);
407 number_pixels=(MagickSizeType) fits_info.columns*fits_info.rows;
408 if ((fits_info.simple == MagickFalse) || (fits_info.number_axes < 1) ||
409 (fits_info.number_axes > 4) || (number_pixels == 0))
410 ThrowReaderException(CorruptImageError,"ImageTypeNotSupported");
cristybb503372010-05-27 20:51:26 +0000411 for (scene=0; scene < (ssize_t) fits_info.number_planes; scene++)
cristy3ed852e2009-09-05 21:47:34 +0000412 {
cristybb503372010-05-27 20:51:26 +0000413 image->columns=(size_t) fits_info.columns;
414 image->rows=(size_t) fits_info.rows;
415 image->depth=(size_t) (fits_info.bits_per_pixel < 0 ? -1 : 1)*
cristy3ed852e2009-09-05 21:47:34 +0000416 fits_info.bits_per_pixel;
417 image->endian=fits_info.endian;
cristybb503372010-05-27 20:51:26 +0000418 image->scene=(size_t) scene;
cristy3ed852e2009-09-05 21:47:34 +0000419 if ((image_info->ping != MagickFalse) && (image_info->number_scenes != 0))
420 if (image->scene >= (image_info->scene+image_info->number_scenes-1))
421 break;
422 /*
423 Initialize image structure.
424 */
425 if ((fits_info.min_data != 0.0) || (fits_info.max_data != 0.0))
426 {
427 if ((fits_info.bits_per_pixel != 0) && (fits_info.max_data == 0.0))
cristybb503372010-05-27 20:51:26 +0000428 fits_info.max_data=GetFITSPixelRange((size_t)
cristy3ed852e2009-09-05 21:47:34 +0000429 fits_info.bits_per_pixel);
430 }
431 else
432 GetFITSPixelExtrema(image,fits_info.bits_per_pixel,&fits_info.min_data,
433 &fits_info.max_data);
434 /*
435 Convert FITS pixels to pixel packets.
436 */
437 scale=(double) QuantumRange/(fits_info.scale*(fits_info.max_data-
438 fits_info.min_data)+fits_info.zero);
cristybb503372010-05-27 20:51:26 +0000439 for (y=(ssize_t) image->rows-1; y >= 0; y--)
cristy3ed852e2009-09-05 21:47:34 +0000440 {
441 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
cristyacd2ed22011-08-30 01:44:23 +0000442 if (q == (Quantum *) NULL)
cristy3ed852e2009-09-05 21:47:34 +0000443 break;
cristybb503372010-05-27 20:51:26 +0000444 for (x=0; x < (ssize_t) image->columns; x++)
cristy3ed852e2009-09-05 21:47:34 +0000445 {
446 pixel=GetFITSPixel(image,fits_info.bits_per_pixel);
cristy4c08aed2011-07-01 19:47:50 +0000447 SetPixelRed(image,ClampToQuantum(scale*(fits_info.scale*
448 (pixel-fits_info.min_data)+fits_info.zero)),q);
449 SetPixelGreen(image,GetPixelRed(image,q),q);
450 SetPixelBlue(image,GetPixelRed(image,q),q);
cristyed231572011-07-14 02:18:59 +0000451 q+=GetPixelChannels(image);
cristy3ed852e2009-09-05 21:47:34 +0000452 }
453 if (SyncAuthenticPixels(image,exception) == MagickFalse)
454 break;
455 if (image->previous == (Image *) NULL)
456 {
cristycee97112010-05-28 00:44:52 +0000457 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
cristy4c08aed2011-07-01 19:47:50 +0000458 image->rows);
cristy3ed852e2009-09-05 21:47:34 +0000459 if (status == MagickFalse)
460 break;
461 }
462 }
463 if (EOFBlob(image) != MagickFalse)
464 {
465 ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
466 image->filename);
467 break;
468 }
469 /*
470 Proceed to next image.
471 */
472 if (image_info->number_scenes != 0)
473 if (image->scene >= (image_info->scene+image_info->number_scenes-1))
474 break;
cristybb503372010-05-27 20:51:26 +0000475 if (scene < (ssize_t) (fits_info.number_planes-1))
cristy3ed852e2009-09-05 21:47:34 +0000476 {
477 /*
478 Allocate next image structure.
479 */
cristy9950d572011-10-01 18:22:35 +0000480 AcquireNextImage(image_info,image,exception);
cristy3ed852e2009-09-05 21:47:34 +0000481 if (GetNextImageInList(image) == (Image *) NULL)
482 {
483 image=DestroyImageList(image);
484 return((Image *) NULL);
485 }
486 image=SyncNextImageInList(image);
487 status=SetImageProgress(image,LoadImagesTag,TellBlob(image),
488 GetBlobSize(image));
489 if (status == MagickFalse)
490 break;
491 }
492 }
493 (void) CloseBlob(image);
494 return(GetFirstImageInList(image));
495}
496
497/*
498%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
499% %
500% %
501% %
502% R e g i s t e r F I T S I m a g e %
503% %
504% %
505% %
506%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
507%
508% RegisterFITSImage() adds attributes for the FITS image format to
509% the list of supported formats. The attributes include the image format
510% tag, a method to read and/or write the format, whether the format
511% supports the saving of more than one frame to the same file or blob,
512% whether the format supports native in-memory I/O, and a brief
513% description of the format.
514%
515% The format of the RegisterFITSImage method is:
516%
cristybb503372010-05-27 20:51:26 +0000517% size_t RegisterFITSImage(void)
cristy3ed852e2009-09-05 21:47:34 +0000518%
519*/
cristybb503372010-05-27 20:51:26 +0000520ModuleExport size_t RegisterFITSImage(void)
cristy3ed852e2009-09-05 21:47:34 +0000521{
522 MagickInfo
523 *entry;
524
525 entry=SetMagickInfo("FITS");
526 entry->decoder=(DecodeImageHandler *) ReadFITSImage;
527 entry->encoder=(EncodeImageHandler *) WriteFITSImage;
528 entry->magick=(IsImageFormatHandler *) IsFITS;
529 entry->adjoin=MagickFalse;
530 entry->seekable_stream=MagickTrue;
531 entry->description=ConstantString("Flexible Image Transport System");
532 entry->module=ConstantString("FITS");
533 (void) RegisterMagickInfo(entry);
534 entry=SetMagickInfo("FTS");
535 entry->decoder=(DecodeImageHandler *) ReadFITSImage;
536 entry->encoder=(EncodeImageHandler *) WriteFITSImage;
537 entry->magick=(IsImageFormatHandler *) IsFITS;
538 entry->adjoin=MagickFalse;
539 entry->seekable_stream=MagickTrue;
540 entry->description=ConstantString("Flexible Image Transport System");
541 entry->module=ConstantString("FTS");
542 (void) RegisterMagickInfo(entry);
543 return(MagickImageCoderSignature);
544}
545
546/*
547%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
548% %
549% %
550% %
551% U n r e g i s t e r F I T S I m a g e %
552% %
553% %
554% %
555%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
556%
557% UnregisterFITSImage() removes format registrations made by the
558% FITS module from the list of supported formats.
559%
560% The format of the UnregisterFITSImage method is:
561%
562% UnregisterFITSImage(void)
563%
564*/
565ModuleExport void UnregisterFITSImage(void)
566{
567 (void) UnregisterMagickInfo("FITS");
568 (void) UnregisterMagickInfo("FTS");
569}
570
571/*
572%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
573% %
574% %
575% %
576% W r i t e F I T S I m a g e %
577% %
578% %
579% %
580%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
581%
582% WriteFITSImage() writes a Flexible Image Transport System image to a
583% file as gray scale intensities [0..255].
584%
585% The format of the WriteFITSImage method is:
586%
587% MagickBooleanType WriteFITSImage(const ImageInfo *image_info,
cristy1e178e72011-08-28 19:44:34 +0000588% Image *image,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000589%
590% A description of each parameter follows.
591%
592% o image_info: the image info.
593%
594% o image: The image.
595%
cristy1e178e72011-08-28 19:44:34 +0000596% o exception: return any errors or warnings in this structure.
597%
cristy3ed852e2009-09-05 21:47:34 +0000598*/
599static MagickBooleanType WriteFITSImage(const ImageInfo *image_info,
cristy1e178e72011-08-28 19:44:34 +0000600 Image *image,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000601{
602 char
603 header[FITSBlocksize],
604 *fits_info;
605
cristy3ed852e2009-09-05 21:47:34 +0000606 MagickBooleanType
607 status;
608
609 QuantumInfo
610 *quantum_info;
611
cristy4c08aed2011-07-01 19:47:50 +0000612 register const Quantum
cristy3ed852e2009-09-05 21:47:34 +0000613 *p;
614
615 size_t
616 length;
617
618 ssize_t
619 count,
cristy2692d592010-11-01 18:07:27 +0000620 offset,
621 y;
cristy3ed852e2009-09-05 21:47:34 +0000622
623 unsigned char
624 *pixels;
625
626 /*
627 Open output image file.
628 */
629 assert(image_info != (const ImageInfo *) NULL);
630 assert(image_info->signature == MagickSignature);
631 assert(image != (Image *) NULL);
632 assert(image->signature == MagickSignature);
633 if (image->debug != MagickFalse)
634 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
cristy3a37efd2011-08-28 20:31:03 +0000635 assert(exception != (ExceptionInfo *) NULL);
636 assert(exception->signature == MagickSignature);
cristy1e178e72011-08-28 19:44:34 +0000637 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
cristy3ed852e2009-09-05 21:47:34 +0000638 if (status == MagickFalse)
639 return(status);
cristy510d06a2011-07-06 23:43:54 +0000640 if (IsRGBColorspace(image->colorspace) == MagickFalse)
cristye941a752011-10-15 01:52:48 +0000641 (void) TransformImageColorspace(image,RGBColorspace,exception);
cristy3ed852e2009-09-05 21:47:34 +0000642 /*
643 Allocate image memory.
644 */
645 fits_info=(char *) AcquireQuantumMemory(FITSBlocksize,sizeof(*fits_info));
646 if (fits_info == (char *) NULL)
647 ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
648 (void) ResetMagickMemory(fits_info,' ',FITSBlocksize*sizeof(*fits_info));
649 /*
650 Initialize image header.
651 */
652 image->depth=GetImageQuantumDepth(image,MagickFalse);
653 quantum_info=AcquireQuantumInfo((const ImageInfo *) NULL,image);
654 if (quantum_info == (QuantumInfo *) NULL)
655 ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
656 offset=0;
cristyb51dff52011-05-19 16:55:47 +0000657 (void) FormatLocaleString(header,FITSBlocksize,
cristy3ed852e2009-09-05 21:47:34 +0000658 "SIMPLE = T");
659 (void) strncpy(fits_info+offset,header,strlen(header));
660 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000661 (void) FormatLocaleString(header,FITSBlocksize,"BITPIX = %10ld",
cristyf2faecf2010-05-28 19:19:36 +0000662 (long) (quantum_info->format == FloatingPointQuantumFormat ? -1 : 1)*
663 image->depth);
cristy3ed852e2009-09-05 21:47:34 +0000664 (void) strncpy(fits_info+offset,header,strlen(header));
665 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000666 (void) FormatLocaleString(header,FITSBlocksize,"NAXIS = %10lu",
cristy1e178e72011-08-28 19:44:34 +0000667 IsImageGray(image,exception) != MagickFalse ? 2UL : 3UL);
cristy3ed852e2009-09-05 21:47:34 +0000668 (void) strncpy(fits_info+offset,header,strlen(header));
669 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000670 (void) FormatLocaleString(header,FITSBlocksize,"NAXIS1 = %10lu",
cristyf2faecf2010-05-28 19:19:36 +0000671 (unsigned long) image->columns);
cristy3ed852e2009-09-05 21:47:34 +0000672 (void) strncpy(fits_info+offset,header,strlen(header));
673 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000674 (void) FormatLocaleString(header,FITSBlocksize,"NAXIS2 = %10lu",
cristyf2faecf2010-05-28 19:19:36 +0000675 (unsigned long) image->rows);
cristy3ed852e2009-09-05 21:47:34 +0000676 (void) strncpy(fits_info+offset,header,strlen(header));
677 offset+=80;
cristy1e178e72011-08-28 19:44:34 +0000678 if (IsImageGray(image,exception) == MagickFalse)
cristyfcbcae82011-04-22 12:53:27 +0000679 {
cristyb51dff52011-05-19 16:55:47 +0000680 (void) FormatLocaleString(header,FITSBlocksize,
cristyfcbcae82011-04-22 12:53:27 +0000681 "NAXIS3 = %10lu",3UL);
682 (void) strncpy(fits_info+offset,header,strlen(header));
683 offset+=80;
684 }
cristyb51dff52011-05-19 16:55:47 +0000685 (void) FormatLocaleString(header,FITSBlocksize,"BSCALE = %E",1.0);
cristy3ed852e2009-09-05 21:47:34 +0000686 (void) strncpy(fits_info+offset,header,strlen(header));
687 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000688 (void) FormatLocaleString(header,FITSBlocksize,"BZERO = %E",
cristy3ed852e2009-09-05 21:47:34 +0000689 image->depth > 8 ? GetFITSPixelRange(image->depth) : 0.0);
690 (void) strncpy(fits_info+offset,header,strlen(header));
691 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000692 (void) FormatLocaleString(header,FITSBlocksize,"DATAMAX = %E",
cristy3ed852e2009-09-05 21:47:34 +0000693 1.0*((MagickOffsetType) GetQuantumRange(image->depth)));
694 (void) strncpy(fits_info+offset,header,strlen(header));
695 offset+=80;
cristyb51dff52011-05-19 16:55:47 +0000696 (void) FormatLocaleString(header,FITSBlocksize,"DATAMIN = %E",0.0);
cristy3ed852e2009-09-05 21:47:34 +0000697 (void) strncpy(fits_info+offset,header,strlen(header));
698 offset+=80;
699 if (image->endian == LSBEndian)
700 {
cristyb51dff52011-05-19 16:55:47 +0000701 (void) FormatLocaleString(header,FITSBlocksize,"XENDIAN = 'SMALL'");
cristy3ed852e2009-09-05 21:47:34 +0000702 (void) strncpy(fits_info+offset,header,strlen(header));
703 offset+=80;
704 }
cristyb51dff52011-05-19 16:55:47 +0000705 (void) FormatLocaleString(header,FITSBlocksize,"HISTORY %.72s",
cristybb503372010-05-27 20:51:26 +0000706 GetMagickVersion((size_t *) NULL));
cristy3ed852e2009-09-05 21:47:34 +0000707 (void) strncpy(fits_info+offset,header,strlen(header));
708 offset+=80;
709 (void) strncpy(header,"END",FITSBlocksize);
710 (void) strncpy(fits_info+offset,header,strlen(header));
711 offset+=80;
712 (void) WriteBlob(image,FITSBlocksize,(unsigned char *) fits_info);
713 /*
714 Convert image to fits scale PseudoColor class.
715 */
716 pixels=GetQuantumPixels(quantum_info);
cristy1e178e72011-08-28 19:44:34 +0000717 if (IsImageGray(image,exception) != MagickFalse)
cristyfcbcae82011-04-22 12:53:27 +0000718 {
719 length=GetQuantumExtent(image,quantum_info,GrayQuantum);
720 for (y=(ssize_t) image->rows-1; y >= 0; y--)
721 {
cristy1e178e72011-08-28 19:44:34 +0000722 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
cristy4c08aed2011-07-01 19:47:50 +0000723 if (p == (const Quantum *) NULL)
cristyfcbcae82011-04-22 12:53:27 +0000724 break;
cristy4c08aed2011-07-01 19:47:50 +0000725 length=ExportQuantumPixels(image,(CacheView *) NULL,quantum_info,
cristy1e178e72011-08-28 19:44:34 +0000726 GrayQuantum,pixels,exception);
cristyfcbcae82011-04-22 12:53:27 +0000727 if (image->depth == 16)
728 SetFITSUnsignedPixels(image->columns,image->depth,pixels);
729 if (((image->depth == 32) || (image->depth == 64)) &&
730 (quantum_info->format != FloatingPointQuantumFormat))
731 SetFITSUnsignedPixels(image->columns,image->depth,pixels);
732 count=WriteBlob(image,length,pixels);
733 if (count != (ssize_t) length)
734 break;
735 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
736 image->rows);
737 if (status == MagickFalse)
738 break;
739 }
740 }
741 else
742 {
743 length=GetQuantumExtent(image,quantum_info,RedQuantum);
744 for (y=(ssize_t) image->rows-1; y >= 0; y--)
745 {
cristy1e178e72011-08-28 19:44:34 +0000746 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
cristy4c08aed2011-07-01 19:47:50 +0000747 if (p == (const Quantum *) NULL)
cristyfcbcae82011-04-22 12:53:27 +0000748 break;
cristy4c08aed2011-07-01 19:47:50 +0000749 length=ExportQuantumPixels(image,(CacheView *) NULL,quantum_info,
cristy1e178e72011-08-28 19:44:34 +0000750 RedQuantum,pixels,exception);
cristyfcbcae82011-04-22 12:53:27 +0000751 if (image->depth == 16)
752 SetFITSUnsignedPixels(image->columns,image->depth,pixels);
753 if (((image->depth == 32) || (image->depth == 64)) &&
754 (quantum_info->format != FloatingPointQuantumFormat))
755 SetFITSUnsignedPixels(image->columns,image->depth,pixels);
756 count=WriteBlob(image,length,pixels);
757 if (count != (ssize_t) length)
758 break;
759 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
760 image->rows);
761 if (status == MagickFalse)
762 break;
763 }
764 length=GetQuantumExtent(image,quantum_info,GreenQuantum);
765 for (y=(ssize_t) image->rows-1; y >= 0; y--)
766 {
cristy1e178e72011-08-28 19:44:34 +0000767 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
cristy4c08aed2011-07-01 19:47:50 +0000768 if (p == (const Quantum *) NULL)
cristyfcbcae82011-04-22 12:53:27 +0000769 break;
cristy4c08aed2011-07-01 19:47:50 +0000770 length=ExportQuantumPixels(image,(CacheView *) NULL,quantum_info,
cristy1e178e72011-08-28 19:44:34 +0000771 GreenQuantum,pixels,exception);
cristyfcbcae82011-04-22 12:53:27 +0000772 if (image->depth == 16)
773 SetFITSUnsignedPixels(image->columns,image->depth,pixels);
774 if (((image->depth == 32) || (image->depth == 64)) &&
775 (quantum_info->format != FloatingPointQuantumFormat))
776 SetFITSUnsignedPixels(image->columns,image->depth,pixels);
777 count=WriteBlob(image,length,pixels);
778 if (count != (ssize_t) length)
779 break;
780 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
781 image->rows);
782 if (status == MagickFalse)
783 break;
784 }
785 length=GetQuantumExtent(image,quantum_info,BlueQuantum);
786 for (y=(ssize_t) image->rows-1; y >= 0; y--)
787 {
cristy1e178e72011-08-28 19:44:34 +0000788 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
cristy4c08aed2011-07-01 19:47:50 +0000789 if (p == (const Quantum *) NULL)
cristyfcbcae82011-04-22 12:53:27 +0000790 break;
cristy4c08aed2011-07-01 19:47:50 +0000791 length=ExportQuantumPixels(image,(CacheView *) NULL,quantum_info,
cristy1e178e72011-08-28 19:44:34 +0000792 BlueQuantum,pixels,exception);
cristyfcbcae82011-04-22 12:53:27 +0000793 if (image->depth == 16)
794 SetFITSUnsignedPixels(image->columns,image->depth,pixels);
795 if (((image->depth == 32) || (image->depth == 64)) &&
796 (quantum_info->format != FloatingPointQuantumFormat))
797 SetFITSUnsignedPixels(image->columns,image->depth,pixels);
798 count=WriteBlob(image,length,pixels);
799 if (count != (ssize_t) length)
800 break;
801 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
802 image->rows);
803 if (status == MagickFalse)
804 break;
805 }
806 }
cristy3ed852e2009-09-05 21:47:34 +0000807 quantum_info=DestroyQuantumInfo(quantum_info);
808 length=(size_t) (FITSBlocksize-TellBlob(image) % FITSBlocksize);
809 if (length != 0)
810 {
811 (void) ResetMagickMemory(fits_info,0,length*sizeof(*fits_info));
812 (void) WriteBlob(image,length,(unsigned char *) fits_info);
813 }
814 fits_info=DestroyString(fits_info);
815 (void) CloseBlob(image);
816 return(MagickTrue);
817}