isisraw.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
struct ISISCRPT_STRUCT;
#include "MantidKernel/System.h"
#include "item_struct.h"
#include <cstdlib>
#include <cstring>
 
struct HDR_STRUCT {
  char inst_abrv[3]; 
  char hd_run[5];    
  char hd_user[20];  
  char hd_title[24]; 
  char hd_date[12];  
  char hd_time[8];   
  char hd_dur[8];    
  HDR_STRUCT() { memset(this, ' ', sizeof(HDR_STRUCT)); }
};
 
struct ADD_STRUCT {
  int ad_run;  
  int ad_inst; 
  int ad_se;   
  int ad_dae;  
  int ad_tcb;  
  int ad_user; 
  int ad_data; 
  int ad_log;  
  int ad_end;  
  ADD_STRUCT() { memset(this, 0, sizeof(ADD_STRUCT)); }
};
 
struct USER_STRUCT {
  char r_user[20];    
  char r_daytel[20];  
  char r_daytel2[20]; 
  char r_night[20];   
  char r_instit[20];  
  char unused[3][20]; 
  USER_STRUCT() { memset(this, ' ', sizeof(USER_STRUCT)); }
};
 
struct RPB_STRUCT {
  int r_dur;             
  int r_durunits;        
  int r_dur_freq;        
  int r_dmp;             
  int r_dmp_units;       
  int r_dmp_freq;        
  int r_freq;            
  float r_gd_prtn_chrg;  
  float r_tot_prtn_chrg; 
  int r_goodfrm;         
  int r_rawfrm;          
  int r_dur_wanted;      
  int r_dur_secs;        
  int r_mon_sum1;        
  int r_mon_sum2;        
  int r_mon_sum3;        
  char r_enddate[12];    
  char r_endtime[8];     
  int r_prop;            
  int spare[10];         
 
  // cppcheck-suppress memsetClassFloat
  RPB_STRUCT() { memset(this, 0, sizeof(RPB_STRUCT)); }
};
 
struct IVPB_STRUCT {
  float i_chfreq;     
  float freq_c2;      
  float freq_c3;      
  int delay_c1;       
  int delay_c2;       
  int delay_c3;       
  int delay_error_c1; 
  int delay_error_c2; 
  int delay_error_c3; 
  float i_chopsiz;    
  int aperture_c2;    
  int aperture_c3;    
  int status_c1;      
  int status_c2;      
  int status_c3;      
  int i_mainshut;     
  int i_thermshut;    
  float i_xsect;      
  float i_ysect;      
  int i_posn;         
  int i_mod;          
  int i_vacuum;       
  float i_l1;         
  int i_rfreq;        
  float i_renergy;    
  float i_rphase;     
  int i_rslit;        
  int i_slowchop;     
  float i_xcen;       
  float i_ycen;       
  int i_bestop;       
  float i_radbest;    
  float i_sddist;     
  float i_foeang;     
  float i_aofi;       
  int spare[29];      
  // cppcheck-suppress memsetClassFloat
  IVPB_STRUCT() { memset(this, 0, sizeof(IVPB_STRUCT)); }
};
 
struct SPB_STRUCT {
  int e_posn;        
  int e_type;        
  int e_geom;        
  float e_thick;     
  float e_height;    
  float e_width;     
  float e_omega;     
  float e_chi;       
  float e_phi;       
  float e_scatt;     
  float e_xscatt;    
  float samp_cs_inc; 
  float samp_cs_abs; 
  float e_dens;      
  float e_canthick;  
  float e_canxsect;  
  float can_cs_inc;  
  float can_cs_abs;  
  float can_nd;      
  char e_name[40];   
  int e_equip;       
  int e_eqname;      
  int spare[33];     
  // cppcheck-suppress memsetClassFloat
  SPB_STRUCT() { memset(this, 0, sizeof(SPB_STRUCT)); }
};
 
struct SE_STRUCT {
  char sep_name[8];     
  int sep_value;        
  int sep_exponent;     
  char sep_units[8];    
  int sep_low_trip;     
  int sep_high_trip;    
  int sep_cur_val;      
  int sep_status;       
  int sep_control;      
  int sep_run;          
  int sep_log;          
  float sep_stable;     
  float sep_period;     
  int sep_cam_addr;     
  int sep_cam_sub;      
  int sep_offset;       
  int sep_cam_rgrp;     
  int sep_pre_proc;     
  int sep_cam_vals[12]; 
  // cppcheck-suppress memsetClassFloat
  SE_STRUCT() { memset(this, 0, sizeof(SE_STRUCT)); }
};
 
struct DAEP_STRUCT {
  int a_pars;           
  int mem_size;         
  int a_minppp;         
  int ppp_good_high;    
  int ppp_good_low;     
  int ppp_raw_high;     
  int ppp_raw_low;      
  int neut_good_high;   
  int neut_good_low;    
  int neut_raw_high;    
  int neut_raw_low;     
  int neut_gate_t1;     
  int neut_gate_t2;     
  int mon1_detector;    
  int mon1_module;      
  int mon1_crate;       
  int mon1_mask;        
  int mon2_detector;    
  int mon2_module;      
  int mon2_crate;       
  int mon2_mask;        
  int events_good_high; 
  int events_good_low;  
  int a_delay;          
  int a_sync;           
  int a_smp;            
  int ext_vetos[3];     
  // extra bits for new PC DAE
  int n_tr_shift;  
  int tr_shift[3]; 
  int spare[31]; 
  DAEP_STRUCT() { memset(this, 0, sizeof(DAEP_STRUCT)); }
};
 
struct DHDR_STRUCT {
  int d_comp;         
  int reserved;       
  int d_offset;       
  float d_crdata;     
  float d_crfile;     
  int d_exp_filesize; 
  int unused[26];     
  DHDR_STRUCT() {
    // cppcheck-suppress memsetClassFloat
    memset(this, 0, sizeof(DHDR_STRUCT));
    d_comp = 1;
    d_offset = 1 + 32;
  }
};
 
struct DDES_STRUCT {
  int nwords; 
  int offset; 
  DDES_STRUCT() : nwords(0), offset(0) {}
};
 
struct LOG_LINE {
  int len;    
  char *data; 
  LOG_LINE() : len(0), data(nullptr) {}
};
 
struct LOG_STRUCT {
  int ver;         
  int nlines;      
  LOG_LINE *lines; 
  LOG_STRUCT() : ver(2), nlines(0), lines(nullptr) {}
};
 
//  isis raw
class ISISRAW {
private:
  ISISCRPT_STRUCT *m_crpt;         
  item_struct<char> m_char_items;  
  item_struct<float> m_real_items; 
  item_struct<int> m_int_items;    
  int addItems();
 
public:
  // section 1
  HDR_STRUCT hdr;        
  int frmt_ver_no;       
  struct ADD_STRUCT add; 
  int data_format;       
  // section 2
  int ver2;         
  int r_number;     
  char r_title[80]; 
  USER_STRUCT user; 
  RPB_STRUCT rpb;   
  // section 3
  int ver3;         
  char i_inst[8];   
  IVPB_STRUCT ivpb; 
  int i_det;        
  int i_mon;        
  int i_use;        
  // I_TABLES is address of MDET
  int *mdet;   
  int *monp;   
  int *spec;   
  float *delt; 
  float *len2; 
  int *code;   
  float *tthe; 
  float *ut;   
  // section 4
  int ver4;       
  SPB_STRUCT spb; 
  int e_nse;      
  SE_STRUCT
  *e_seblock; 
  // section 5
  int ver5;         
  DAEP_STRUCT daep; 
  // A_TABLES points at CRAT
  int *crat; 
  int *modn; 
  int *mpos; 
  int *timr; 
  int *udet; 
  // section 6
  int ver6;           
  int t_ntrg;         
  int t_nfpp;         
  int t_nper;         
  int t_pmap[256];    
  int t_nsp1;         
  int t_ntc1;         
  int t_tcm1[5];      
  float t_tcp1[5][4]; 
  int t_pre1;         
  int *t_tcb1;        
  // section 7
  // write NCHAN = NTC1+1 time channel boundaries
  int ver7;     
  int u_len;    
  float *u_dat; 
  // section 8
  int ver8;         
  DHDR_STRUCT dhdr; 
  // D_DATA points at ddes
  DDES_STRUCT
  *ddes;              
  uint32_t *dat1;     
  LOG_STRUCT logsect; 
 
public:
  static int vmstime(char *timbuf, int len, time_t time_value);
  int size_check();
  ISISRAW();
  virtual ~ISISRAW();
  explicit ISISRAW(ISISCRPT_STRUCT *crpt);
  ISISRAW(ISISCRPT_STRUCT *crpt, bool doUpdateFromCRPT);
 
  // Explicitly prevent copying with all the dynamic allocations
  ISISRAW(const ISISRAW &) = delete;
  ISISRAW &operator=(ISISRAW) = delete;
 
  int updateFromCRPT();
 
  virtual int ioRAW(FILE *file, bool from_file, bool read_data = true);
  int ioRAW(FILE *file, HDR_STRUCT *s, int len, bool from_file);
  int ioRAW(FILE *file, ADD_STRUCT *s, int len, bool from_file);
  int ioRAW(FILE *file, USER_STRUCT *s, int len, bool from_file);
  int ioRAW(FILE *file, RPB_STRUCT *s, int len, bool from_file);
  int ioRAW(FILE *file, IVPB_STRUCT *s, int len, bool from_file);
  int ioRAW(FILE *file, SPB_STRUCT *s, int len, bool from_file);
  int ioRAW(FILE *file, SE_STRUCT *s, int len, bool from_file);
  int ioRAW(FILE *file, DAEP_STRUCT *s, int len, bool from_file);
  int ioRAW(FILE *file, DHDR_STRUCT *s, int len, bool from_file);
  int ioRAW(FILE *file, DDES_STRUCT *s, int len, bool from_file);
  int ioRAW(FILE *file, LOG_STRUCT *s, int len, bool from_file);
  int ioRAW(FILE *file, LOG_LINE *s, int len, bool from_file);
  int ioRAW(FILE *file, char *s, int len, bool from_file);
  int ioRAW(FILE *file, int *s, int len, bool from_file);
  int ioRAW(FILE *file, uint32_t *s, int len, bool from_file);
  int ioRAW(FILE *file, float *s, int len, bool from_file);
  // allocate
  int ioRAW(FILE *file, char **s, int len, bool from_file);
  int ioRAW(FILE *file, int **s, int len, bool from_file);
  int ioRAW(FILE *file, uint32_t **s, int len, bool from_file);
  int ioRAW(FILE *file, float **s, int len, bool from_file);
  int ioRAW(FILE *file, SE_STRUCT **s, int len, bool from_file);
  int ioRAW(FILE *file, DDES_STRUCT **s, int len, bool from_file);
  int ioRAW(FILE *file, LOG_LINE **s, int len, bool from_file);
  int readFromFile(const char *filename, bool read_data = true);
  int printInfo(std::ostream &os);
  int getTimeChannels(float *rtcb1, int n);
};