API Reference

Class Hierarchy

• • Namespace trx
    • Enum ConnectivityMeasure
    • Enum TrxCompression
    • Enum TrxSaveMode
    • Enum TrxScalarType
    • Template Struct ArraySequence
    • Struct ConnectivityMatrixResult
    • Template Struct DTypeName
    • Template Struct DTypeName< double >
    • Template Struct DTypeName< float >
    • Template Struct DTypeName< int16_t >
    • Template Struct DTypeName< int32_t >
    • Template Struct DTypeName< int64_t >
    • Template Struct DTypeName< int8_t >
    • Template Struct DTypeName< uint16_t >
    • Template Struct DTypeName< uint32_t >
    • Template Struct DTypeName< uint64_t >
    • Template Struct DTypeName< uint8_t >
    • Struct LoadFloat32Options
    • Struct MergeTrxShardsOptions
    • Template Struct MMappedMatrix
    • Struct PositionsOutputInfo
    • Struct PrepareOutputOptions
    • Struct TrxSaveOptions
    • Struct TypedArray
      • Struct TypedArray::ByteView
      • Struct TypedArray::MutableByteView
    • Class AnyTrxFile
    • Class TrxArgumentError
    • Class TrxDTypeError
    • Class TrxError
    • Template Class TrxFile
      • Struct TrxFile::GroupBackingInfo
    • Class TrxFormatError
    • Class TrxIOError
    • Template Class TrxReader
    • Class TrxStream
      • Struct TrxStream::FieldValues
      • Struct TrxStream::MetadataFile

File Hierarchy

• • File dtype_helpers.h
  • File exceptions.h
  • File nifti_io.h
  • File streamlines_ops.h
  • File trx.h
  • File trx.tpp
  • File zip_raii.h

Full API

Namespaces

• Namespace std

• Namespace trx
  • Classes
  • Enums
  • Functions
  • Typedefs
  • Variables

Classes and Structs

• Template Struct ArraySequence
  • Struct Documentation
    • trx::ArraySequence
      • data()
      • data()
      • offsets()
      • offsets()
      • lengths()
      • lengths()
      • ArraySequence()
      • _data
      • _offsets
      • _lengths
      • _data_owned
      • _offsets_owned
      • mmap_pos
      • mmap_off

• Struct ConnectivityMatrixResult
  • Struct Documentation
    • trx::ConnectivityMatrixResult
      • group_names
      • streamline_count_upper
      • value_upper

• Template Struct DTypeName
  • Struct Documentation
    • trx::DTypeName
      • value()
      • supported

• Template Struct DTypeName< double >
  • Struct Documentation
    • trx::DTypeName< double >
      • value()
      • supported

• Template Struct DTypeName< float >
  • Struct Documentation
    • trx::DTypeName< float >
      • value()
      • supported

• Template Struct DTypeName< int16_t >
  • Struct Documentation
    • trx::DTypeName< int16_t >
      • value()
      • supported

• Template Struct DTypeName< int32_t >
  • Struct Documentation
    • trx::DTypeName< int32_t >
      • value()
      • supported

• Template Struct DTypeName< int64_t >
  • Struct Documentation
    • trx::DTypeName< int64_t >
      • value()
      • supported

• Template Struct DTypeName< int8_t >
  • Struct Documentation
    • trx::DTypeName< int8_t >
      • value()
      • supported

• Template Struct DTypeName< uint16_t >
  • Struct Documentation
    • trx::DTypeName< uint16_t >
      • value()
      • supported

• Template Struct DTypeName< uint32_t >
  • Struct Documentation
    • trx::DTypeName< uint32_t >
      • value()
      • supported

• Template Struct DTypeName< uint64_t >
  • Struct Documentation
    • trx::DTypeName< uint64_t >
      • value()
      • supported

• Template Struct DTypeName< uint8_t >
  • Struct Documentation
    • trx::DTypeName< uint8_t >
      • value()
      • supported

• Struct LoadFloat32Options
  • Struct Documentation
    • trx::LoadFloat32Options
      • chunk_rows

• Struct MergeTrxShardsOptions
  • Struct Documentation
    • trx::MergeTrxShardsOptions
      • shard_directories
      • output_path
      • compression
      • output_directory
      • overwrite_existing

• Template Struct MMappedMatrix
  • Struct Documentation
    • trx::MMappedMatrix
      • matrix()
      • matrix()
      • MMappedMatrix()
      • _matrix
      • _matrix_owned
      • mmap

• Struct PositionsOutputInfo
  • Struct Documentation
    • trx::PositionsOutputInfo
      • directory
      • positions_path
      • dtype
      • points

• Struct PrepareOutputOptions
  • Struct Documentation
    • trx::PrepareOutputOptions
      • overwrite_existing

• Struct TrxFile::GroupBackingInfo
  • Nested Relationships
  • Struct Documentation
    • trx::TrxFile::GroupBackingInfo
      • filename
      • rows
      • cols
      • dtype
      • mem_offset

• Struct TrxSaveOptions
  • Struct Documentation
    • trx::TrxSaveOptions
      • compression
      • mode
      • memory_limit_bytes
      • overwrite_existing
      • positions_dtype

• Struct TrxStream::FieldValues
  • Nested Relationships
  • Struct Documentation
    • trx::TrxStream::FieldValues
      • dtype
      • values

• Struct TrxStream::MetadataFile
  • Nested Relationships
  • Struct Documentation
    • trx::TrxStream::MetadataFile
      • relative_path
      • absolute_path

• Struct TypedArray
  • Nested Relationships
    • Nested Types
  • Struct Documentation
    • trx::TypedArray
      • empty()
      • size()
      • as_matrix()
      • as_matrix()
      • to_bytes()
      • to_bytes_mutable()
      • materialize_to_owned()
      • dtype
      • rows
      • cols
      • mmap
      • owned
      • trx::TypedArray::ByteView
        • data
        • size
      • trx::TypedArray::MutableByteView
        • data
        • size

• Struct TypedArray::ByteView
  • Nested Relationships
  • Struct Documentation
    • trx::TypedArray::ByteView
      • data
      • size

• Struct TypedArray::MutableByteView
  • Nested Relationships
  • Struct Documentation
    • trx::TypedArray::MutableByteView
      • data
      • size

• Class AnyTrxFile
  • Class Documentation
    • trx::AnyTrxFile
      • PositionsChunkCallback
      • PositionsChunkMutableCallback
      • AnyTrxFile()
      • ~AnyTrxFile()
      • AnyTrxFile()
      • operator=()
      • AnyTrxFile()
      • operator=()
      • num_vertices()
      • num_streamlines()
      • close()
      • save()
      • save()
      • get_dps()
      • get_dpv()
      • get_streamline()
      • for_each_positions_chunk()
      • for_each_positions_chunk_mutable()
      • backing_directory()
      • backing_directory()
      • uncompressed_folder_handle()
      • uncompressed_folder_handle()
      • header
      • positions
      • offsets
      • offsets_u64
      • lengths
      • groups
      • data_per_streamline
      • data_per_vertex
      • data_per_group
      • load()
      • load_from_zip()
      • load_from_directory()

• Class TrxArgumentError
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • trx::TrxArgumentError

• Class TrxDTypeError
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • trx::TrxDTypeError

• Class TrxError
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • trx::TrxError

• Template Class TrxFile
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • trx::TrxFile
      • TrxFile()
      • ~TrxFile()
      • deepcopy()
      • resize()
      • save()
      • save()
      • normalize_for_save()
      • add_dps_from_text()
      • add_dps_from_vector()
      • add_dpv_from_vector()
      • add_group_from_indices()
      • set_voxel_to_rasmm()
      • add_dpv_from_tsf()
      • export_dpv_to_tsf()
      • close()
      • _cleanup_temporary_directory()
      • num_vertices()
      • num_streamlines()
      • make_empty_like()
      • build_streamline_aabbs()
      • get_or_build_streamline_aabbs()
      • invalidate_aabb_cache()
      • query_aabb()
      • subset_streamlines()
      • get_dps()
      • get_dpv()
      • get_group_members()
      • get_streamline()
      • for_each_streamline()
      • compute_group_connectivity()
      • add_dpg_from_vector()
      • add_dpg_from_matrix()
      • get_dpg()
      • list_dpg_groups()
      • list_dpg_fields()
      • remove_dpg()
      • remove_dpg_group()
      • uncompressed_folder_handle()
      • uncompressed_folder_handle()
      • _copy_fixed_arrays_from()
      • len()
      • header
      • streamlines
      • groups
      • data_per_streamline
      • data_per_vertex
      • data_per_group
      • _uncompressed_folder_handle
      • _copy_safe
      • _owns_uncompressed_folder
      • _create_trx_from_pointer()
      • load_from_zip()
      • load_from_directory()
      • load()
      • load
      • trx::TrxFile::GroupBackingInfo
        • filename
        • rows
        • cols
        • dtype
        • mem_offset

• Class TrxFormatError
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • trx::TrxFormatError

• Class TrxIOError
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • trx::TrxIOError

• Template Class TrxReader
  • Class Documentation
    • trx::TrxReader
      • TrxReader()
      • ~TrxReader()
      • TrxReader()
      • operator=()
      • TrxReader()
      • operator=()
      • get()
      • operator*()
      • operator->()

• Class TrxStream
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • trx::TrxStream
      • MetadataMode
        • InMemory
        • OnDisk
      • TrxStream()
      • ~TrxStream()
      • TrxStream()
      • operator=()
      • TrxStream()
      • operator=()
      • push_streamline()
      • push_streamline()
      • push_streamline()
      • set_positions_buffer_max_bytes()
      • set_metadata_mode()
      • set_metadata_buffer_max_bytes()
      • set_voxel_to_rasmm()
      • set_dimensions()
      • push_dps_from_vector()
      • push_dpv_from_vector()
      • push_group_from_indices()
      • finalize()
      • finalize()
      • finalize()
      • finalize_directory()
      • finalize_directory_persistent()
      • num_streamlines()
      • num_vertices()
      • header

Enums

• Enum ConnectivityMeasure
  • Enum Documentation
    • ConnectivityMeasure
      • StreamlineCount
      • DpsSum

• Enum TrxCompression
  • Enum Documentation
    • TrxCompression
      • None
      • Deflate

• Enum TrxSaveMode
  • Enum Documentation
    • TrxSaveMode
      • Auto
      • Archive
      • Directory

• Enum TrxScalarType
  • Enum Documentation
    • TrxScalarType
      • Float16
      • Float32
      • Float64

Functions

• Function trx::_create_memmap
  • Function Documentation
    • _create_memmap()

• Template Function trx::_generate_filename_from_data
  • Function Documentation
    • _generate_filename_from_data()

• Template Function trx::_initialize_empty_trx
  • Function Documentation
    • _initialize_empty_trx()

• Function trx::_json_object
  • Function Documentation
    • _json_object()

• Function trx::_json_set
  • Function Documentation
    • _json_set()

• Function trx::allocate_file
  • Function Documentation
    • allocate_file()

• Function trx::append_dps_to_directory
  • Function Documentation
    • append_dps_to_directory()

• Function trx::append_dps_to_zip
  • Function Documentation
    • append_dps_to_zip()

• Function trx::append_dpv_to_directory
  • Function Documentation
    • append_dpv_to_directory()

• Function trx::append_dpv_to_zip
  • Function Documentation
    • append_dpv_to_zip()

• Function trx::append_groups_to_directory
  • Function Documentation
    • append_groups_to_directory()

• Function trx::append_groups_to_zip
  • Function Documentation
    • append_groups_to_zip()

• Function trx::assignHeader
  • Function Documentation
    • assignHeader()

• Function trx::copy_dir
  • Function Documentation
    • copy_dir()

• Function trx::copy_file
  • Function Documentation
    • copy_file()

• Function trx::detect_positions_dtype
  • Function Documentation
    • detect_positions_dtype()

• Function trx::detect_positions_scalar_type
  • Function Documentation
    • detect_positions_scalar_type()

• Function trx::difference
  • Function Documentation
    • difference()

• Template Function trx::dtype_from_scalar
  • Function Documentation
    • dtype_from_scalar()

• Template Function trx::ediff1d
  • Function Documentation
    • ediff1d()

• Function trx::extract_trx_archive
  • Function Documentation
    • extract_trx_archive()

• Function trx::format_groups_summary
  • Function Documentation
    • format_groups_summary()

• Function trx::get_base
  • Function Documentation
    • get_base()

• Function trx::get_ext
  • Function Documentation
    • get_ext()

• Function trx::get_reference_info
  • Function Documentation
    • get_reference_info()

• Function trx::get_streamline_key
  • Function Documentation
    • get_streamline_key()

• Function trx::hash_streamlines
  • Function Documentation
    • hash_streamlines()

• Function trx::intersection
  • Function Documentation
    • intersection()

• Function trx::is_trx_directory
  • Function Documentation
    • is_trx_directory()

• Template Function trx::load
  • Function Documentation
    • load()

• Function trx::load_any
  • Function Documentation
    • load_any()

• Function trx::load_float32_positions
  • Function Documentation
    • load_float32_positions()

• Template Function trx::load_from_directory
  • Function Documentation
    • load_from_directory()

• Template Function trx::load_from_zip
  • Function Documentation
    • load_from_zip()

• Function trx::make_temp_dir
  • Function Documentation
    • make_temp_dir()

• Function trx::merge_trx_shards
  • Function Documentation
    • merge_trx_shards()

• Template Function trx::operator<<
  • Function Documentation
    • operator<<()

• Function trx::path_basename
  • Function Documentation
    • path_basename()

• Function trx::path_dirname
  • Function Documentation
    • path_dirname()

• Function trx::perform_streamlines_operation
  • Function Documentation
    • perform_streamlines_operation()

• Function trx::populate_fps
  • Function Documentation
    • populate_fps()

• Function trx::prepare_positions_output
  • Function Documentation
    • prepare_positions_output()

• Function trx::read_nifti_voxel_to_rasmm
  • Function Documentation
    • read_nifti_voxel_to_rasmm()

• Function trx::rm_dir
  • Function Documentation
    • rm_dir()

• Function trx::rm_root
  • Function Documentation
    • rm_root()

• Function trx::round_to_precision
  • Function Documentation
    • round_to_precision()

• Function trx::scalar_type_name
  • Function Documentation
    • scalar_type_name()

• Function trx::to_utf8_string
  • Function Documentation
    • to_utf8_string()

• Function trx::union_maps
  • Function Documentation
    • union_maps()

• Template Function trx::with_trx_reader
  • Function Documentation
    • with_trx_reader()

• Function trx::write_positions_as_dtype
  • Function Documentation
    • write_positions_as_dtype()

• Function trx::write_trx_archive
  • Function Documentation
    • write_trx_archive()

Variables

• Variable trx::dtypes
  • Variable Documentation
    • dtypes

• Variable trx::kMinNbPoints
  • Variable Documentation
    • kMinNbPoints

• Variable trx::SEPARATOR
  • Variable Documentation
    • SEPARATOR

Typedefs

• Typedef json
  • Typedef Documentation
    • json

• Typedef trx::StreamlineKeyMap
  • Typedef Documentation
    • StreamlineKeyMap