Welcome to brukerapi’s documentation!

Bruker API documentation.

Tutorials:

• Installation
  • Using pip
  • From source
• How to work with Bruker study?
• How to load a 2dseq file?
• How to load a fid file?
• How to load a PV360 rawdata job?
• How to read parametric files
• How to filter Bruker directories?
• Command line interface (CLI)
  • report
  • split
  • filter
  • pipelines

Modules:

• Dataset
  • Construction and load stages
  • Raw acquisition and k-space views
  • Metadata views
• Folders
  • Folder
    • Folder.__init__()
    • Folder.validate()
    • Folder.__str__()
    • Folder.make_children_map()
    • Folder.__getattr__()
    • Folder.__getitem__()
    • Folder.query()
    • Folder.clean()
    • Folder.get_dataset_list()
    • Folder.get_dataset_list_rec()
    • Folder.get_jcampdx_list()
    • Folder.get_experiment_list()
    • Folder.get_processing_list()
    • Folder.get_study_list()
    • Folder.make_tree()
    • Folder.contains()
    • Folder.print()
    • Folder.to_dict()
    • Folder.__weakref__
  • Study
    • Study.__init__()
    • Study.validate()
    • Study.get_dataset()
  • Experiment
    • Experiment.__init__()
    • Experiment.validate()
  • Processing
    • Processing.__init__()
    • Processing.validate()
• JCAMPDX
  • Parameter
    • Parameter.__init__()
    • Parameter.__str__()
    • Parameter.__repr__()
    • Parameter.nested
    • Parameter.__weakref__
  • GenericParameter
    • GenericParameter.__init__()
  • HeaderParameter
    • HeaderParameter.__init__()
  • DataParameter
    • DataParameter.__init__()
  • JCAMPDX
    • JCAMPDX.__init__()
    • JCAMPDX.__str__()
    • JCAMPDX.to_json()
    • JCAMPDX.get_value()
    • JCAMPDX.get_list()
    • JCAMPDX.__weakref__
    • JCAMPDX.read_jcampdx()
    • JCAMPDX.strip_size_bracket()
    • JCAMPDX.wrap_lines()
    • JCAMPDX.write()
• Schemas
  • Schema
    • Schema.__init__()
    • Schema.permutation_inverse()
    • Schema.__weakref__
  • SchemaFid
    • SchemaFid.acquisition_factor
    • SchemaFid.continuous_train
    • SchemaFid.mirror_odd_lines
    • SchemaFid.layouts
    • SchemaFid.raw()
    • SchemaFid.to_kspace()
  • SchemaFidCompanion
    • SchemaFidCompanion.__init__()
    • SchemaFidCompanion.__weakref__
  • SchemaTraj
  • SchemaRawdata
    • SchemaRawdata.raw()
    • SchemaRawdata.to_kspace()
  • Schema2dseq
    • Schema2dseq.ra()

Test data:

• Data for testing

Compatibility:

• Compatibility
  • Tested ParaVision releases
  • Dataset types
  • Acquisition schemes
  • Data contract and limitations

Indices and tables

• Index

• Module Index

• Search Page