SimCATS-Datasets

Examples

  • Examples PyTorch SimcatsDataset
    • Imports
    • Configs Examples: Using Strings or Callables
    • Examples for Different Ground Truth Types
      • TCT Masks
      • TCT by Dot Masks
      • IDT Masks
      • CT Masks
      • CT by Dot Masks
      • TC Region Masks
      • TC Region Minus TCT Masks
      • C Region Masks
    • Examples for Preprocessors
      • Adding the Color-Channel-Axis
      • Restrict Ground Truth to Only Two Classes
    • Preloading vs. Loading on Demand
      • Config
      • Load and Measure Time
  • Dataset Generation: random_variations_v2 Dataset
    • Imports
    • Dataset Config
    • Create Samplers for Different Parts of the Simulation
      • Total Charge Transition (TCT) Parameter Sampler
      • Noise Samplers
        • Occupation Distortions
          • OccupationDotJumps
          • OccupationTransitionBlurringFermiDirac
        • Sensor Potential Distortions
          • SensorPotentialPinkNoise
          • SensorPotentialRTN
        • Sensor Response Distortions
          • SensorResponseRTN
          • SensorResponseWhiteNoise
      • Sensor Sampler
        • SensorGeneric with SensorPeakLorentzian
    • Sample SimCATS Configs (Modify Default Config)
    • Create Dataset
    • Examplary Plot Images from a Generated Dataset

API Reference

  • simcats_datasets
    • Subpackages
      • simcats_datasets.generation
        • Package Contents
          • Functions
        • Package Implementation Details
          • create_dataset()
          • create_simulated_dataset()
          • add_ct_by_dot_masks_to_dataset()
      • simcats_datasets.loading
        • Submodules
          • simcats_datasets.loading.load_ground_truth
            • Module Contents
              • Functions
            • Module Implementation Details
              • load_zeros_masks()
              • load_tct_masks()
              • load_tct_by_dot_masks()
              • load_idt_masks()
              • load_ct_masks()
              • load_ct_by_dot_masks()
              • load_tc_region_masks()
              • load_tc_region_minus_tct_masks()
              • load_c_region_masks()
              • load_sensor_potential()
              • load_compensated_sensor_potential()
              • load_charge_transition_sensor_phase_shift()
              • load_sensor_regime_masks()
              • load_sensor_peak_center_masks()
              • load_sensor_oscillation_boundaries_masks()
              • load_sensor_quadrilateral_oscillation_boundaries_masks()
          • simcats_datasets.loading.pytorch
            • Module Contents
              • Classes
            • Module Implementation Details
              • SimcatsDataset
                • SimcatsDataset.h5_path
                • SimcatsDataset.sensor_scan_dataset
                • SimcatsDataset.specific_ids
                • SimcatsDataset.load_ground_truth
                • SimcatsDataset.data_preprocessors
                • SimcatsDataset.ground_truth_preprocessors
                • SimcatsDataset.format_output
                • SimcatsDataset.preload
                • SimcatsDataset.progress_bar
                • SimcatsDataset.shape
              • SimcatsConcatDataset
                • SimcatsConcatDataset.shape
                • SimcatsConcatDataset.h5_paths
                • SimcatsConcatDataset.sensor_scan_dataset
                • SimcatsConcatDataset.specific_ids
                • SimcatsConcatDataset.load_ground_truth
                • SimcatsConcatDataset.data_preprocessors
                • SimcatsConcatDataset.ground_truth_preprocessors
                • SimcatsConcatDataset.format_output
                • SimcatsConcatDataset.preload
                • SimcatsConcatDataset.progress_bar
                • SimcatsConcatDataset.datasets
                • SimcatsConcatDataset.cumulative_sizes
                • SimcatsConcatDataset.cumsum()
                • SimcatsConcatDataset.cummulative_sizes
        • Package Contents
          • Functions
        • Package Implementation Details
          • load_dataset()
      • simcats_datasets.support_functions
        • Submodules
          • simcats_datasets.support_functions.clip_line_to_rectangle
            • Module Contents
              • Functions
            • Module Implementation Details
              • clip_slope_line_to_rectangle()
              • clip_infinite_slope_line_to_rectangle()
              • clip_point_line_to_rectangle()
              • is_point_inside_rectangle()
              • line_intersection()
              • create_rectangle_corners()
          • simcats_datasets.support_functions.convert_lines
            • Module Contents
              • Functions
            • Module Implementation Details
              • lines_voltage_to_pixel_space()
              • lines_pixel_to_voltage_space()
              • lines_convert_two_coordinates_to_coordinate_plus_change()
              • points_2d_voltage_to_1d_idx_space()
          • simcats_datasets.support_functions.data_preprocessing
            • Module Contents
              • Functions
            • Module Implementation Details
              • example_preprocessor()
              • cast_to_float32()
              • quantize_to_int_bit_depth()
              • cast_to_float16()
              • standardization()
              • min_max_0_1()
              • min_max_0_1_global()
              • min_max_0_1_given_limits()
              • min_max_minus_one_one()
              • add_newaxis()
              • only_two_classes()
              • absolute_values()
              • shrink_to_shape()
              • shrink_to_shape_96x96()
              • resample_image()
              • resample_image_to_32x32()
              • decimate_image()
              • standardize_to_dataset()
              • bm3d_smoothing()
              • vertical_median_smoothing()
          • simcats_datasets.support_functions.get_coulomb_oscillation_area_boundaries
            • Module Contents
              • Functions
            • Module Implementation Details
              • get_coulomb_oscillation_area_boundaries()
              • extend_pinch_off_line_to_edge()
              • calc_oscillation_area_boundaries_intersect_points()
              • calc_potential_offset()
              • calc_sensor_potential()
              • calc_fully_conductive_potential()
              • calc_track_boundaries_intersect_points()
          • simcats_datasets.support_functions.get_lead_transition_labels
            • Module Contents
              • Functions
            • Module Implementation Details
              • get_lead_transition_labels()
          • simcats_datasets.support_functions.metadata_utils
            • Module Contents
              • Functions
            • Module Implementation Details
              • reconstruct_metadata_types()
          • simcats_datasets.support_functions.pytorch_format_output
            • Module Contents
              • Functions
            • Module Implementation Details
              • format_dict_csd_float_ground_truth_long()
              • format_dict_csd_float16_ground_truth_long()
              • format_dict_csd_float_ground_truth_float()
              • format_mmsegmentation()
              • format_csd_only()
              • format_csd_float16_only()
              • format_csd_bfloat16_only()
              • format_csd_class_index()
              • format_tuple_csd_float_ground_truth_float()
SimCATS-Datasets
  • simcats_datasets
  • simcats_datasets.support_functions
  • View page source

simcats_datasets.support_functions

Module with support functions for different main functionalities.

Submodules

  • simcats_datasets.support_functions.clip_line_to_rectangle
  • simcats_datasets.support_functions.convert_lines
  • simcats_datasets.support_functions.data_preprocessing
  • simcats_datasets.support_functions.get_coulomb_oscillation_area_boundaries
  • simcats_datasets.support_functions.get_lead_transition_labels
  • simcats_datasets.support_functions.metadata_utils
  • simcats_datasets.support_functions.pytorch_format_output
Previous Next

© Copyright 2026 Peter Grünberg Institute - Integrated Computing Architectures (ICA / PGI-4), Forschungszentrum Jülich GmbH.

Built with Sphinx using a theme provided by Read the Docs.