OFFIS DCMTK  Version 3.6.0
i2dimgs.h
1 /*
2  *
3  * Copyright (C) 2001-2010, OFFIS e.V.
4  * All rights reserved. See COPYRIGHT file for details.
5  *
6  * This software and supporting documentation were developed by
7  *
8  * OFFIS e.V.
9  * R&D Division Health
10  * Escherweg 2
11  * D-26121 Oldenburg, Germany
12  *
13  *
14  * Module: dcmdata
15  *
16  * Author: Michael Onken
17  *
18  * Purpose: Base Class for plugins extracting pixel data from standard
19  * image files
20  *
21  * Last Update: $Author: joergr $
22  * Update Date: $Date: 2010-10-14 13:15:46 $
23  * CVS/RCS Revision: $Revision: 1.9 $
24  * Status: $State: Exp $
25  *
26  * CVS/RCS Log at end of file
27  *
28  */
29 
30 #ifndef I2DIMGS_H
31 #define I2DIMGS_H
32 
33 #include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
34 
35 #include "dcmtk/ofstd/ofcond.h"
36 #include "dcmtk/dcmdata/dcxfer.h"
37 
39 {
40 
41 public:
42 
46 
50  virtual OFString inputFormat() const =0;
51 
76  virtual OFCondition readPixelData( Uint16& rows,
77  Uint16& cols,
78  Uint16& samplesPerPixel,
79  OFString& photoMetrInt,
80  Uint16& bitsAlloc,
81  Uint16& bitsStored,
82  Uint16& highBit,
83  Uint16& pixelRepr,
84  Uint16& planConf,
85  Uint16& pixAspectH,
86  Uint16& pixAspectV,
87  char*& pixData,
88  Uint32& length,
89  E_TransferSyntax& ts) =0;
90 
91  /* After reading of pixel data, this function can be used for getting
92  * information about lossy compression parameters.
93  * @param srcEncodingLossy - [out] Denotes, whether the encoding of the pixel
94  * data read was lossy (OFtrue) or lossless (OFFalse)
95  * @param srcLossyComprMethod - [out] Denotes the lossy compression method used
96  * in source if there is one (srcEncodingLossy = OFTrue).
97  * Should use defined terms of attribute Lossy Compression Method.
98  * @return EC_Normal if information is available, error otherwise
99  */
100  virtual OFCondition getLossyComprInfo(OFBool& srcEncodingLossy,
101  OFString& srcLossyComprMethod) const =0;
102 
107  void setImageFile(const OFString& filename) { m_imageFile = filename; };
108 
113 
116  virtual ~I2DImgSource() {}
117 
118 protected:
119 
122 
123 };
124 
125 #endif // #ifndef I2DIMGS_H
126 
127 /*
128  * CVS/RCS Log:
129  * $Log: i2dimgs.h,v $
130  * Revision 1.9 2010-10-14 13:15:46 joergr
131  * Updated copyright header. Added reference to COPYRIGHT file.
132  *
133  * Revision 1.8 2010-02-22 11:39:54 uli
134  * Remove some unneeded includes.
135  *
136  * Revision 1.7 2009-11-04 09:58:08 uli
137  * Switched to logging mechanism provided by the "new" oflog module
138  *
139  * Revision 1.6 2009-09-30 08:05:25 uli
140  * Stop including dctk.h in libi2d's header files.
141  *
142  * Revision 1.5 2009-07-16 14:22:19 onken
143  * Changed comment (and thus semantic of parameter for output transfer syntax).
144  *
145  * Revision 1.4 2009-03-31 13:06:09 onken
146  * Changed implementation of lossy compression attribute detection and writing.
147  *
148  * Revision 1.2 2009-01-16 09:51:55 onken
149  * Completed doxygen documentation for libi2d.
150  *
151  * Revision 1.1 2008-01-16 15:08:38 onken
152  * Moved library "i2dlib" from /dcmdata/libsrc/i2dlib to /dcmdata/libi2d
153  *
154  * Revision 1.2 2008-01-11 14:17:53 onken
155  * Added various options to i2dlib. Changed logging to use a configurable
156  * logstream. Added output plugin for the new Multiframe Secondary Capture SOP
157  * Classes. Added mode for JPEG plugin to copy exsiting APPn markers (except
158  * JFIF). Changed img2dcm default behaviour to invent type1/type2 attributes (no
159  * need for templates any more). Added some bug fixes.
160  *
161  * Revision 1.1 2007/11/08 15:58:55 onken
162  * Initial checkin of img2dcm application and corresponding library i2dlib.
163  *
164  *
165  */
166 


Generated on Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2