itkStreamingImageIOBase.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 itkStreamingImageIOBase_h
#define itkStreamingImageIOBase_h
#include "ITKIOImageBaseExport.h"
 
#include "itkImageIOBase.h"
 
#include <fstream>
 
namespace itk
{
class ITKIOImageBase_EXPORT StreamingImageIOBase : public ImageIOBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(StreamingImageIOBase);

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

  itkOverrideGetNameOfClassMacro(StreamingImageIOBase);
 
  // see super class for documentation
  //
  // overridden to return true
  bool
  CanStreamWrite() override;
 
  // see super class for documentation
  //
  // overridden to return true
  bool
  CanStreamRead() override;
 
  // see super class for documentation
  //
  // If UseStreamedReading is true, then returned region is the
  // requested region parameter.
  ImageIORegion
  GenerateStreamableReadRegionFromRequestedRegion(const ImageIORegion & requestedRegion) const override;
 
  // see super class for documentation
  //
  // Verifies the set file name meets the pasting requirements, then calls
  // GetActualNumberOfSplitsForWritingCanStreamWrite
  unsigned int
  GetActualNumberOfSplitsForWriting(unsigned int          numberOfRequestedSplits,
                                    const ImageIORegion & pasteRegion,
                                    const ImageIORegion & largestPossibleRegion) override;
 
protected:
  StreamingImageIOBase();
  // virtual ~StreamingImageIOBase(); not needed
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  virtual bool
  RequestedToStream() const;

  virtual bool
  ReadBufferAsBinary(std::istream & is, void * buffer, SizeType num);

  virtual bool
  WriteBufferAsBinary(std::ostream & os, const void * buffer, SizeType num);

  virtual bool
  StreamReadBufferAsBinary(std::istream & file, void * _buffer);

  virtual bool
  StreamWriteBufferAsBinary(std::ostream & file, const void * _buffer);

  virtual SizeType
  GetHeaderSize() const = 0;

  virtual SizeType
  GetDataPosition() const
  {
    return this->GetHeaderSize();
  }
};
} // namespace itk
 
#endif