vtkDICOMParser.h

/*=========================================================================
 
  Program: DICOM for VTK
 
  Copyright (c) 2012-2024 David Gobbi
  All rights reserved.
  See Copyright.txt or http://dgobbi.github.io/bsd3.txt for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkDICOMParser_h
#define vtkDICOMParser_h
 
#include "vtkObject.h"
#include "vtkStdString.h" // For std::string
#include "vtkDICOMModule.h" // For export macro
#include "vtkDICOMConfig.h" // For configuration details
#include "vtkDICOMCharacterSet.h" // For character sets
 
// Declare VTK classes within VTK's optional namespace
#if defined(VTK_ABI_NAMESPACE_BEGIN)
VTK_ABI_NAMESPACE_BEGIN
#endif
 
class vtkUnsignedShortArray;
 
#if defined(VTK_ABI_NAMESPACE_BEGIN)
VTK_ABI_NAMESPACE_END
#endif
 
class vtkDICOMFile;
class vtkDICOMItem;
class vtkDICOMMetaData;
class vtkDICOMParserInternalFriendship;
 
 
class VTKDICOM_EXPORT vtkDICOMParser : public vtkObject
{
public:
  static vtkDICOMParser *New();
 
  vtkTypeMacro(vtkDICOMParser, vtkObject);
 
  void PrintSelf(ostream& os, vtkIndent indent) VTK_DICOM_OVERRIDE;
 
  vtkSetStringMacro(FileName);
  vtkGetStringMacro(FileName);
 
  void SetMetaData(vtkDICOMMetaData *);
  vtkDICOMMetaData *GetMetaData() { return this->MetaData; }
 
  vtkSetMacro(Index, int);
  int GetIndex() { return this->Index; }
 
 
  void SetDefaultCharacterSet(vtkDICOMCharacterSet cs);
  vtkDICOMCharacterSet GetDefaultCharacterSet() {
    return this->DefaultCharacterSet; }
 
 
  void SetOverrideCharacterSet(bool b);
  void OverrideCharacterSetOn() {
    this->SetOverrideCharacterSet(true); }
  void OverrideCharacterSetOff() {
    this->SetOverrideCharacterSet(false); }
  bool GetOverrideCharacterSet() {
    return this->OverrideCharacterSet; }
 
 
  void SetQuery(vtkDICOMMetaData *query);
  vtkDICOMMetaData *GetQuery() { return this->Query; }
 
 
  void SetQueryItem(const vtkDICOMItem& query);
 
 
  void SetGroups(vtkUnsignedShortArray *groups);
  vtkUnsignedShortArray *GetGroups() { return this->Groups; }
 
  bool GetQueryMatched() { return this->QueryMatched; }
 
  bool GetPixelDataFound() { return this->PixelDataFound; }
 
  unsigned int GetPixelDataVL() { return this->PixelDataVL; }
 
 
  vtkTypeInt64 GetFileOffset() { return this->FileOffset; }
 
  vtkTypeInt64 GetFileSize() { return this->FileSize; }
 
 
  void SetBufferSize(int size);
  int GetBufferSize() { return this->BufferSize; }
 
  virtual void Update();
 
  unsigned long GetErrorCode() { return this->ErrorCode; }
 
protected:
  vtkDICOMParser();
  ~vtkDICOMParser() VTK_DICOM_OVERRIDE;
 
 
  virtual bool FillBuffer(
    const unsigned char* &cp, const unsigned char* &ep);
 
 
  virtual bool SeekBuffer(
    const unsigned char* &cp, const unsigned char* &ep, vtkTypeInt64 offset);
 
 
  virtual bool SkipValue(
    const unsigned char* &cp, const unsigned char* &ep, unsigned int vl);
 
  virtual vtkTypeInt64 GetBytesRemaining(
    const unsigned char *cp, const unsigned char *ep);
 
  virtual void ParseError(
    const unsigned char *cp, const unsigned char *ep, const char *message);
 
  void SetErrorCode(unsigned long e) { this->ErrorCode = e; }
 
  virtual bool ReadFile(vtkDICOMMetaData *data, int idx);
 
  bool ReadMetaHeader(
    const unsigned char* &cp, const unsigned char* &ep,
    vtkDICOMMetaData *data, int idx);
 
  bool ReadMetaData(
    const unsigned char* &cp, const unsigned char* &ep,
    vtkDICOMMetaData *data, int idx);
 
  vtkTypeInt64 GetBytesProcessed(
    const unsigned char* cp, const unsigned char* ep);
 
  char *FileName;
  std::string TransferSyntax;
  vtkDICOMMetaData *MetaData;
  vtkDICOMMetaData *Query;
  vtkDICOMItem *QueryItem;
  vtkUnsignedShortArray *Groups;
  vtkDICOMFile *InputFile;
  vtkTypeInt64 BytesRead;
  vtkTypeInt64 FileOffset;
  vtkTypeInt64 FileSize;
  unsigned char *Buffer;
  int BufferSize;
  int ChunkSize;
  int Index;
  unsigned int PixelDataVL;
  bool PixelDataFound;
  bool QueryMatched;
  vtkDICOMCharacterSet DefaultCharacterSet;
  bool OverrideCharacterSet;
  unsigned long ErrorCode;
 
  // used to share FillBuffer with internal classes
  friend class vtkDICOMParserInternalFriendship;
 
private:
#ifdef VTK_DICOM_DELETE
  vtkDICOMParser(const vtkDICOMParser&) VTK_DICOM_DELETE;
  void operator=(const vtkDICOMParser&) VTK_DICOM_DELETE;
#else
  vtkDICOMParser(const vtkDICOMParser&) = delete;
  void operator=(const vtkDICOMParser&) = delete;
#endif
};
 
#endif /* vtkDICOMParser_h */