SoVRSegyFileReader.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : G. SEGUIN (Oct 2001)
**=======================================================================*/
#ifndef  _SO_VR_SEGY_FILE_READER_
#define  _SO_VR_SEGY_FILE_READER_
 
#include <LDM/readers/SoVolumeReader.h>
#include <VolumeViz/readers/SoVRSegyReader.h>
#include <Inventor/STL/vector>
#include <VolumeViz/nodes/SoVolumeData.h>
 
#ifdef _WIN32
#pragma warning( push )
#pragma warning(disable:4251)
#endif
 
class  SoVRSegyFileReader : public SoVolumeReader  
{
  SO_FIELDCONTAINER_HEADER(SoVRSegyFileReader);
 
 public:
  SoVRSegyFileReader();
 
  virtual ReadError getDataChar( SbBox3f &size, SoDataSet::DataType &type,  SbVec3i32 &dim ) override;
 
  virtual void getSubSlice( const SbBox2i32& subSlice, int sliceNumber, void * data );
 
  virtual SbBool setDirectCoordSysAutoDetection(SbBool autoValue);
 
  static void setVolumeSizeVoxels(SbBool flag);
 
  virtual SoVolumeReader::ReaderType getReaderType ()
  {return SEGY;};
 
 
  // Reader Settings - Step 0
  //
 
  virtual int setFilename( const SbString& filename );
 
  enum SegyScanningResp {
     SCAN_CONTINUE,
     SCAN_ABORT
  };
 
  typedef SegyScanningResp SoSegyScanningCB( void *data, float percent, SoVRSegyFileReader *reader );
 
  void setScanningProgressCallback( SoSegyScanningCB *func, void *data );
 
  // Reader Settings - Step 1
  //
 
    virtual void setSegyTextHeaderAscii( bool ascii );
 
    virtual SbString getSegyTextHeader();
 
  // Reader Settings - Step 2
  //
 
  enum SegyByteOrder { 
    SEGY_LITTLE_ENDIAN,
    SEGY_BIG_ENDIAN
  };
  virtual void setSegyByteOrder( SegyByteOrder byteOrder );
  virtual SegyByteOrder getSegyByteOrder();
 
  virtual SbBool setSegyFileHeader( const SoVRSegyFileHeader &fileHeader );
 
  virtual SbBool getSegyFileHeader( SoVRSegyFileHeader& fileHeader, bool readFile = false );
 
  // Reader Settings - Step 3
  //
 
  virtual void setSegyTraceHeaderBytePosition( const SoVRSegyTraceHeaderBytePosition &traceHeaderBytePosition );
  virtual SoVRSegyTraceHeaderBytePosition getSegyTraceHeaderBytePosition();
 
  virtual int getNumTraces();
 
  virtual SbBool getSegyTraceHeader( int traceNumber, SoVRSegyTraceIdHeader& traceHeader );
 
  //void setSegyTraceHeader(int traceNumber, SoVRSegyTraceIdHeader &traceHeader)
  //{;}
 
  // Reader Settings - Step 4
  //
 
  virtual SbBool isSegyRegular();
 
  virtual void setCrosslineRange( int from, int to, int step );
  virtual void setInlineRange( int from, int to, int step );
  virtual void setZRange( int from, int to, int step );
  virtual void getCrosslineRange( int &from, int &to, int &step );
  virtual void getInlineRange( int &from, int &to, int &step );
  virtual void getZRange( int &from, int &to, int &step );
 
  // Reader Settings - Step 5
  //
 
  virtual SbBool getP1P2P3Coordinates( SbVec2d &P1, SbVec2d &P2, SbVec2d &P3, SbVec2d &P4 );
 
  virtual SbBool setDirectCoorSys( SbBool directCoord );
 
  enum SegyAxisOrder {
    XYZ_AS_SAMPLE_INLINE_CROSSLINE,
    XYZ_AS_INLINE_CROSSLINE_SAMPLE
  };
 
  virtual void setSegyAxisOrder( SegyAxisOrder axisOrder );
 
  virtual SegyAxisOrder getSegyAxisOrder();
 
  // Reader Settings - Step 6
  //
 
  virtual int getSegyTraceData( int traceNumber, void* &traceData, int start = 0, int size = -1 );
 
  /*
   * Return the (X,Y) coordinates of trace(i,j).
   */
  bool getTraceCoord(const int i, const int j, SbVec2d & P );
 
  // Reader Settings - Step 7
  //
 
  virtual SbBool setOutputDataType( SbBool doChange, SoDataSet::DataType type );
 
  virtual SbBool setInputDataRange( SbBool doChange, double min, double max );
 
  //
  // End Reader Settings
 
private:
 
  /*
   * Converts numValues IBM float values in IEEE float values into the same in/out buffer.
   */
  static void ibm2ieee( int numValues, void* ibm2ieeeBuffer );
 
 private:
  // settings parameters - step 0
  SoSegyScanningCB *m_scanningCBfunc;
  void             *m_scanningCBdata;
 
  // settings parameters - step 1
  bool m_textHeaderAscii;
 
  // settings parameters - step 2
  SegyByteOrder      m_byteOrder;
  bool               m_byteOrderSet;
  bool               m_swapBytes;     // True if we need to swap the bytes of headers
  bool               m_swapBytesData; // True if we need to swap the bytes of the data samples. Equal to m_swapBytes most of the cases.
  SoVRSegyFileHeader m_binHeader;
  bool               m_binHeaderSet;
 
  // settings parameters - step 3
  SoVRSegyTraceHeaderBytePosition m_trHdrBytePos;
  bool m_trHdrBytePosSet;
 
  // settings parameters - step 4
  bool m_crosslineRangeSet;
  int  m_crosslineFrom, m_crosslineTo, m_crosslineStep;
  bool m_inlineRangeSet;
  int  m_inlineFrom, m_inlineTo, m_inlineStep;
  bool m_zRangeSet;
  int  m_zFrom, m_zTo, m_zStep;
 
  // settings parameters - step 5
  SegyAxisOrder m_axisOrder;
 
  // settings parameters - step 7
  bool m_changeFormat;
  SoDataSet::DataType m_typeOut;
  bool m_dataRangeSet;
  double m_dataRangeMin, m_dataRangeMax;
 
  // getDataChar1
  SoVolumeReader::ReadError getDataChar1();
  bool m_dataChar1;
  SoVRSegyFileHeader m_wkHeader;
  int m_headerSize;
  int m_format;
  SbString m_typeStr;
  SoDataSet::DataType m_type;
  bool m_constantTraceLength;
  unsigned int m_numSamplesPerTrace;
  unsigned int m_numTracesPerLine;
  unsigned int m_numLines;
  int64_t m_numTraces;
 
  // getDataChar2
  SoVolumeReader::ReadError getDataChar2(int t = -1);
  bool m_dataChar2;
  std::vector<int64_t> m_traceOffset;
  std::vector<int> m_traceLength;
  //int64_t m_numTraces;
  //unsigned int m_numSamplesPerTrace;
  SbVec3i32 m_dim; // [0]
 
  // getDataChar3
  SoVolumeReader::ReadError getDataChar3();
  bool m_dataChar3;
  bool m_regularTraceNum;
 
 private:
  using SoVolumeReader::getDataChar;
  using SoVolumeReader::getSubSlice;
 
  // True if format=1 in the file header means IEEE float format.
  // Officially 1 means IBM float format and 5 means IEEE.
  SbBool m_floatIsIEEE;
  static bool m_isVolumeSizeVoxels ;
 
  int  getTraceNum( const int, const int );
  void resetObject();
  bool searchForPoint( const int which, int & i, int & j, SbVec2d & P );
  void extrapolatePoint( SbVec2d & P0, int & i0, int & j0,
                         const SbVec2d & Px, int ix, int jx,
                         const SbVec2d & Py, int iy, int jy,
                         int newi0, int newj0 );
  float evaluateValuesValidity( const int num_values, const float *values );
  float evaluateValuesCorrelation( const int trace, const int format1, const bool swap1, const int format2, const bool swap2 );
 
  int m_crosslineMin;
 
  // For each inline, a list of crossline start/stop pairs.
  // Only computed if there are missing traces.
  std::vector<std::vector<int>> m_traceMap;
};
 
#ifdef _WIN32
#pragma warning( pop )
#endif
 
#endif // _SO_VR_SEGY_FILE_READER_