itkPhilipsRECImageIO.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkPhilipsRECImageIO_h
#define itkPhilipsRECImageIO_h
#include "ITKIOPhilipsRECExport.h"


#include "itkImageIOBase.h"
#include "itkVectorContainer.h"
#include "vnl/vnl_vector_fixed.h"

namespace itk
{
class ITKIOPhilipsREC_EXPORT PhilipsRECImageIO:public ImageIOBase
{
public:
  typedef PhilipsRECImageIO    Self;
  typedef ImageIOBase          Superclass;
  typedef SmartPointer< Self > Pointer;

  itkNewMacro(Self);

  itkTypeMacro(PhilipsRECImageIO, Superclass);

  typedef VectorContainer< unsigned int, double > EchoTimesContainerType;
  typedef VectorContainer< unsigned int, double > TriggerTimesContainerType;
  typedef VectorContainer< unsigned int, double > RepetitionTimesContainerType;
  typedef vnl_vector_fixed< int, 2 >              ScanResolutionType;
  typedef vnl_vector_fixed< float, 3 >            FOVType;
  typedef vnl_vector_fixed< double, 3 >           AngulationMidSliceType;
  typedef vnl_vector_fixed< double, 3 >           OffCentreMidSliceType;
  typedef vnl_vector_fixed< float, 3 >            PhaseEncodingVelocityType;

  typedef vnl_vector_fixed< int, 8 >    ImageTypesType;
  typedef vnl_vector_fixed< int, 8 >    ScanningSequencesType;
  typedef Superclass::IndexValueType    IndexValueType;
  typedef std::vector< IndexValueType > SliceIndexType;
  typedef vnl_vector_fixed< double, 3 > ImageTypeRescaleValuesType;

  typedef VectorContainer< unsigned int, ImageTypeRescaleValuesType > ImageTypeRescaleValuesContainerType;
  typedef ImageTypeRescaleValuesContainerType::Pointer
  ImageTypeRescaleValuesContainerTypePtr;
  typedef VectorContainer< unsigned int,
                           ImageTypeRescaleValuesContainerTypePtr > ScanningSequenceImageTypeRescaleValuesContainerType;
  typedef double                                                 GradientBvalueType;
  typedef VectorContainer< unsigned int, GradientBvalueType >    GradientBvalueContainerType;
  typedef vnl_vector_fixed< double, 3 >                          GradientDirectionType;
  typedef VectorContainer< unsigned int, GradientDirectionType > GradientDirectionContainerType;
  typedef VectorContainer< unsigned int, int >                   LabelTypesASLContainerType;

  /*-------- This part of the interfaces deals with reading data. ----- */

  virtual bool CanReadFile(const char *FileNameToRead) ITK_OVERRIDE;

  virtual void ReadImageInformation() ITK_OVERRIDE;

  virtual void Read(void *buffer) ITK_OVERRIDE;

  /*-------- This part of the interfaces deals with writing data. ----- */

  virtual bool CanWriteFile( const char *itkNotUsed(FileNameToWrite) ) ITK_OVERRIDE
  {
    return false;
  }

  virtual void WriteImageInformation() ITK_OVERRIDE
  {
    return;
  }

  virtual void Write( const void *itkNotUsed(buffer) ) ITK_OVERRIDE
  {
    return;
  }

protected:
  PhilipsRECImageIO();
  ~PhilipsRECImageIO();
  void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

private:

  PhilipsRECImageIO(const Self &) ITK_DELETE_FUNCTION;
  void operator=(const Self &) ITK_DELETE_FUNCTION;

  void SwapBytesIfNecessary(void *buffer, SizeValueType numberOfPixels);

  IndexValueType GetSliceIndex(IndexValueType index) const;

  SliceIndexType *       m_SliceIndex;
  ImageIOBase::ByteOrder m_MachineByteOrder;
};
} // end namespace itk

#endif // itkPhilipsRECImageIO_h