SimpleITK  1.3.0.dev466
sitkImageSeriesWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright Insight Software Consortium
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0.txt
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 *=========================================================================*/
18 #ifndef sitkImageSeriesWriter_h
19 #define sitkImageSeriesWriter_h
20 
21 #include "sitkMacro.h"
22 #include "sitkImage.h"
23 #include "sitkProcessObject.h"
24 #include "sitkIO.h"
26 
27 namespace itk {
28 
29 // Forward declaration for pointer
30 class ImageIOBase;
31 
32  namespace simple {
33 
50  : public ProcessObject
51  {
52  public:
54 
55  virtual ~ImageSeriesWriter();
56 
58 
60  virtual std::string ToString() const;
61 
64  virtual std::vector<std::string> GetRegisteredImageIOs() const;
65 
78  virtual SITK_RETURN_SELF_TYPE_HEADER SetImageIO(const std::string &imageio);
79  virtual std::string GetImageIO( void ) const;
80  /* @} */
81 
83  virtual std::string GetName() const { return std::string("ImageSeriesWriter"); }
84 
91  SITK_RETURN_SELF_TYPE_HEADER SetUseCompression( bool UseCompression );
92  bool GetUseCompression( void ) const;
93 
94  SITK_RETURN_SELF_TYPE_HEADER UseCompressionOn( void ) { return this->SetUseCompression(true); }
95  SITK_RETURN_SELF_TYPE_HEADER UseCompressionOff( void ) { return this->SetUseCompression(false); }
104  SITK_RETURN_SELF_TYPE_HEADER SetCompressionLevel(int);
105  int GetCompressionLevel(void) const;
114  SITK_RETURN_SELF_TYPE_HEADER SetCompressor(const std::string &);
115  std::string GetCompressor(void);
123  SITK_RETURN_SELF_TYPE_HEADER SetFileNames ( const std::vector<std::string> &fileNames );
124  const std::vector<std::string> &GetFileNames() const;
128  SITK_RETURN_SELF_TYPE_HEADER Execute( const Image& );
129  SITK_RETURN_SELF_TYPE_HEADER Execute( const Image &image, const std::vector<std::string> &inFileNames, bool useCompression, int compressionLevel );
130 
131  protected:
132 
133  template <class TImageType> Self &ExecuteInternal ( const Image& inImage );
134 
135  private:
136 
137  itk::SmartPointer<ImageIOBase> GetImageIOBase(const std::string &fileName);
138 
139  // function pointer type
140  typedef Self& (Self::*MemberFunctionType)( const Image& );
141 
142  // friend to get access to executeInternal member
143  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
144  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
145 
148  std::string m_Compressor;
149 
150  std::vector<std::string> m_FileNames;
151 
152  std::string m_ImageIOName;
153  };
154 
155  SITKIO_EXPORT void
156  WriteImage(const Image & image,
157  const std::vector<std::string> & fileNames,
158  bool useCompression = false,
159  int compressionLevel = -1);
160  }
161 }
162 
163 #endif
std::vector< std::string > m_FileNames
Self & UseCompressionOff(void)
Enable compression if available for file type.
Self &(Self::* MemberFunctionType)(const Image &)
virtual std::string GetName() const
Writer series of image from a SimpleITK image.
SITKIO_EXPORT void WriteImage(const Image &image, const std::string &fileName, bool useCompression=false, int compressionLevel=-1)
#define SITKIO_EXPORT
Definition: sitkIO.h:33
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
The Image class for SimpleITK.
Definition: sitkImage.h:78
Self & UseCompressionOn(void)
Enable compression if available for file type.
SITKIO_HIDDEN std::vector< std::string > GetRegisteredImageIOs()
Base class for SimpleITK classes based on ProcessObject.