itkJPEG2000ImageIO.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkJPEG2000ImageIO_h
#define itkJPEG2000ImageIO_h
 
 
#include <fstream>
#include "ITKIOJPEG2000Export.h"
#include "itkStreamingImageIOBase.h"
#include "memory"
 
 
namespace itk
{
 
class JPEG2000ImageIOInternal;
class JPEG2000ImageIOInternalEnums;
class JPEG2000ImageIOInternalEnums
{
public:
  enum class DecodingFormat : uint8_t
  {
    J2K_CFMT = 0,
    JP2_CFMT = 1,
    JPT_CFMT = 2,
    MJ2_CFMT = 3
  };

  enum class DFMFormat : uint8_t
  {
    PXM_DFMT = 0,
    PGX_DFMT = 1,
    BMP_DFMT = 2,
    YUV_DFMT = 3
  };
};
// Define how to print enumeration
extern ITKIOJPEG2000_EXPORT std::ostream &
                            operator<<(std::ostream & out, const JPEG2000ImageIOInternalEnums::DecodingFormat value);
extern ITKIOJPEG2000_EXPORT std::ostream &
                            operator<<(std::ostream & out, const JPEG2000ImageIOInternalEnums::DFMFormat value);

class ITKIOJPEG2000_EXPORT JPEG2000ImageIO : public StreamingImageIOBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(JPEG2000ImageIO);

  using Self = JPEG2000ImageIO;
  using Superclass = StreamingImageIOBase;
  using Pointer = SmartPointer<Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(JPEG2000ImageIO);
 
  /*-------- This part of the interfaces deals with reading data. ----- */

  bool
  CanReadFile(const char *) override;

  void
  ReadImageInformation() override;

  void
  Read(void * buffer) override;
 
  /*-------- This part of the interfaces deals with writing data. ----- */

  bool
  CanWriteFile(const char *) override;

  void
  WriteImageInformation() override;

  void
  Write(const void * buffer) override;

  ImageIORegion
  GenerateStreamableReadRegionFromRequestedRegion(const ImageIORegion & requestedRegion) const override;

  SizeType
  GetHeaderSize() const override;

  void
  SetTileSize(int x, int y);

  bool
  CanStreamWrite() override;
 
protected:
  JPEG2000ImageIO();
  ~JPEG2000ImageIO() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  std::unique_ptr<JPEG2000ImageIOInternal> m_Internal;
 
  using SizeValueType = ImageIORegion::SizeValueType;
  using IndexValueType = ImageIORegion::IndexValueType;
 
  void
  ComputeRegionInTileBoundaries(unsigned int dimension, SizeValueType tileSize, ImageIORegion & streamableRegion) const;
};
} // end namespace itk
 
#endif // itkJPEG2000ImageIO_h