vtkHDRReader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkHDRReader_h
#define vtkHDRReader_h

#include "vtkDeprecation.h"   // For VTK_DEPRECATED_IN_9_6_0
#include "vtkIOImageModule.h" // For export macro
#include "vtkImageReader.h"
#include <string> // for std::string
#include <vector> // for std::vector

VTK_ABI_NAMESPACE_BEGIN
class VTKIOIMAGE_EXPORT vtkHDRReader : public vtkImageReader
{
public:
  static vtkHDRReader* New();
  vtkTypeMacro(vtkHDRReader, vtkImageReader);

  void PrintSelf(ostream& os, vtkIndent indent) override;

  enum FormatType
  {
    FORMAT_32BIT_RLE_RGBE = 0,
    FORMAT_32BIT_RLE_XYZE
  };


  vtkGetMacro(Format, int);


  vtkGetMacro(Gamma, double);


  vtkGetMacro(Exposure, double);


  vtkGetMacro(PixelAspect, double);


  int CanReadFile(VTK_FILEPATH const char* fname) override;
  int CanReadFile(vtkResourceStream* stream) override;

  const char* GetFileExtensions() override { return ".hdr .pic"; }

  const char* GetDescriptiveName() override { return "Radiance HDR"; }

protected:
  vtkHDRReader();
  ~vtkHDRReader() override;

  std::string ProgramType;
  FormatType Format;
  double Gamma;
  double Exposure;
  double PixelAspect;

  bool FlippedX = false;

  bool SwappedAxis = false;

  void ExecuteInformation() override;
  void ExecuteDataWithInformation(vtkDataObject* out, vtkInformation* outInfo) override;
  bool HDRReaderUpdateSlice(float* outPtr, int* outExt);
  void HDRReaderUpdate(vtkImageData* data, float* outPtr);

  VTK_DEPRECATED_IN_9_6_0("Do not use, use Streams instead")
  bool HasError(istream* is);

  int GetWidth() const;
  int GetHeight() const;

  bool ReadHeaderData();

  void ConvertAllDataFromRGBToXYZ(float* outPtr, int size);

  void FillOutPtrRLE(int* outExt, float*& outPtr, std::vector<unsigned char>& lineBuffer);
  void FillOutPtrNoRLE(int* outExt, float*& outPtr, std::vector<unsigned char>& lineBuffer);

  void RGBE2Float(unsigned char rgbe[4], float& r, float& g, float& b);

  static void XYZ2RGB(const float convertMatrix[3][3], double gamma, float& r, float& g, float& b);

private:
  vtkHDRReader(const vtkHDRReader&) = delete;
  void operator=(const vtkHDRReader&) = delete;

  bool ReadAllFileNoRLE(vtkResourceStream* stream, float* outPtr, int decrPtr, int* outExt);

  bool ReadLineRLE(vtkResourceStream* stream, unsigned char* lineBufferPtr);

  // Internal ExecuteInformation() validation flag
  bool Validated = false;
};
VTK_ABI_NAMESPACE_END
#endif