Skip to main content
Ctrl+K

  • Getting Started
  • C++ API Reference
  • NuMagSANS GitHub
  • GitHub
  • Getting Started
  • C++ API Reference
  • NuMagSANS GitHub
  • GitHub

Section Navigation

  • Namespace LogSystem
  • Namespace std
  • Struct Column
  • Struct InputFileData
  • Struct MagDataProperties
  • Struct MagnetizationData
  • Struct NucDataProperties
  • Struct NuclearData
  • Template Struct Option
  • Struct OutFlag
  • Struct OutFlagQuant
  • Struct PrefixEntry
  • Struct ScalingFactors
  • Struct ScatteringData
  • Struct SpectralComponent
  • Struct SpectralData
  • Struct StructDataProperties
  • Struct StructureData
  • Struct SuffixEntry
  • Function allocate_MagnetizationDataGPU
  • Function allocate_MagnetizationDataRAM
  • Function allocate_NuclearDataGPU
  • Function allocate_NuclearDataRAM
  • Function allocate_ScatteringData_GPU
  • Function allocate_ScatteringData_RAM
  • Function allocate_SpectralData_GPU
  • Function allocate_SpectralData_RAM
  • Function allocate_StructureDataGPU
  • Function allocate_StructureDataRAM
  • Function any_active
  • Function Atomistic_MagSANS_Kernel
  • Function Atomistic_MagSANS_Kernel_dilute
  • Function Atomistic_NucSANS_Kernel
  • Function Atomistic_NucSANS_Kernel_dilute
  • Function Atomistic_NuMagSANS_Kernel
  • Function Atomistic_NuMagSANS_Kernel_dilute
  • Function AzimuthalAverage
  • Function build_Corr1D_columns
  • Function build_Corr2D_columns
  • Function build_SANS1D_columns
  • Function build_SANS2D_columns
  • Function build_spectral_amplitudes
  • Function build_spectral_intensities
  • Function check_element_names_MagData
  • Function check_element_names_NucData
  • Function check_FileDimensions_MagData
  • Function check_FileDimensions_NucData
  • Function Check_Idx_Consistency
  • Function Check_Nom_Consistency
  • Function check_number_of_elements_in_folders_MagData
  • Function check_number_of_elements_in_folders_NucData
  • Function Check_SinglePoint
  • Function Check_SingleUnderscore
  • Function check_Subfolder_FileNames_MagData
  • Function check_Subfolder_FileNames_NucData
  • Function check_Subfolders_MagData
  • Function check_Subfolders_NucData
  • Function CheckStrings_ElementNames
  • Function CheckStrings_FolderNames
  • Function Compute_RotMat
  • Function ComputeAngularSpectrumAmplitudes
  • Function ComputeSpectralDecomposition
  • Function copyGPU2RAM_ScatteringData
  • Function copyGPU2RAM_SpectralData
  • Function CorrelationFunction_2D
  • Function count_NumberOfElements
  • Function count_NumberOfFolders
  • Function CountAtomNumbers_MagData
  • Function CountAtomNumbers_NucData
  • Function CountColumnsAndRowsInMagDataFile
  • Function disp_MagnetizationData
  • Function disp_NuclearData
  • Function disp_StructureData
  • Function DistributionFunctions
  • Function free_MagnetizationData
  • Function free_NuclearData
  • Function free_ScatteringData
  • Function free_SpectralData
  • Function free_StructureData
  • Function get_GlobalMagDataPath
  • Function get_GlobalNucDataPath
  • Function get_GlobalStructDataPath
  • Function init_MagnetizationData
  • Function init_NuclearData
  • Function init_ScalingFactors
  • Function init_ScatteringData
  • Function init_SpectralData
  • Function init_StructureData
  • Function InitializeLogSystem
  • Function LogSystem::close
  • Function LogSystem::initLog
  • Function LogSystem::write
  • Function MagData_Observer
  • Function NucData_Observer
  • Function NuMagSANS_Calculator
  • Function Number_Of_Comma_In_String
  • Function NumberOfEntriesInNucFile
  • Function NumberOfEntriesInStructureFile
  • Function NumberOfNonZeroMagneticMomentsInFile
  • Function NumberOfNonZeroMagneticMomentsInFile2
  • Function parse_int_list
  • Function parseStringNoCout
  • Function read_FolderNames
  • Function read_MagnetizationData
  • Function read_NuclearData
  • Function read_StructureData
  • Function ReadCSV__Input_File_Interpreter
  • Function ReadCSV_double_matrix
  • Function ReadCSV_double_vector
  • Function ReadCSV_float_vector
  • Function scale_ScatteringData
  • Function scale_SpectralData
  • Function sort_integ
  • Function Split_Nom_Idx
  • Function Split_Nom_Idx_Type
  • Function StructData_Observer
  • Function SumIntList2
  • Function trim
  • Function try_extract_value
  • Function User_Selection_To_Int_Array
  • Function write2CSV_SpectralData
  • Function write2CSVtable_ScatteringData
  • Function write_amplitude_csv
  • Function write_spectral_csv
  • Function writeCSV
  • Function WriteCSV_double_vector
  • Function WriteCSV_float_matrix
  • Function WriteCSV_float_vector
  • Variable LogSystem::logFile
  • C++ API Reference
  • Template Struct Option

Template Struct Option#

  • Defined in File NuMagSANSlib_InputFileInterpreter.h

Struct Documentation#

template<typename T>
struct Option#

Public Members

std::string key#
T *target#
bool required#
bool found = false#

previous

Struct NuclearData

next

Struct OutFlag
On this page
  • Struct Documentation
    • Option
      • key
      • target
      • required
      • found

© Copyright 2025, Michael P. Adams, Andreas Michels.

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.16.1.