API Reference

Contents:

• bidsbuilder.main_module
  • BidsDataset
    • BidsDataset.__init__()
    • BidsDataset.add_subject()
    • BidsDataset.build()
    • BidsDataset.dataset_description
    • BidsDataset.read()
    • BidsDataset.tree
• bidsbuilder.modules.core.dataset_core
  • DatasetCore
    • DatasetCore.__init__()
    • DatasetCore.create()
    • DatasetCore.delete_self()
    • DatasetCore.exists
    • DatasetCore.filename
  • UnknownFile
    • UnknownFile.__init__()
    • UnknownFile.create()
    • UnknownFile.delete_self()
    • UnknownFile.exists
    • UnknownFile.filename
• bidsbuilder.modules.core.dataset_tree
  • Directory
    • Directory.__init__()
    • Directory.add_child()
    • Directory.add_tree_node()
    • Directory.children
    • Directory.fetch()
    • Directory.is_dir
    • Directory.name
    • Directory.parent
    • Directory.path
    • Directory.relative_path
  • FileCollection
    • FileCollection.__init__()
    • FileCollection.add_child()
    • FileCollection.add_tree_node()
    • FileCollection.children
    • FileCollection.fetch()
    • FileCollection.is_dir
    • FileCollection.name
    • FileCollection.parent
    • FileCollection.path
    • FileCollection.relative_path
  • FileEntry
    • FileEntry.__init__()
    • FileEntry.is_dir
    • FileEntry.name
    • FileEntry.parent
    • FileEntry.path
    • FileEntry.relative_path
• bidsbuilder.modules.core.filenames
  • CompositeFilename
    • CompositeFilename.__init__()
    • CompositeFilename.create()
    • CompositeFilename.datatype
    • CompositeFilename.entities
    • CompositeFilename.local_name
    • CompositeFilename.name
    • CompositeFilename.parent
    • CompositeFilename.resolved_datatype
    • CompositeFilename.resolved_entities
    • CompositeFilename.resolved_suffix
    • CompositeFilename.schema
    • CompositeFilename.suffix
    • CompositeFilename.update_entity()
  • agnosticFilename
    • agnosticFilename.__init__()
    • agnosticFilename.local_name
    • agnosticFilename.name
    • agnosticFilename.parent
• bidsbuilder.modules.file_bases.agnostic_files
• bidsbuilder.modules.file_bases.directories
  • Session
    • Session.__init__()
    • Session.add_datatype()
    • Session.children
    • Session.create()
    • Session.delete_self()
    • Session.exists
    • Session.filename
    • Session.n
    • Session.val
  • Subject
    • Subject.__init__()
    • Subject.add_datatype()
    • Subject.add_session()
    • Subject.anonymise()
    • Subject.children
    • Subject.create()
    • Subject.delete_self()
    • Subject.exists
    • Subject.filename
    • Subject.n
    • Subject.participants
    • Subject.val
• bidsbuilder.modules.file_bases.file_collection
  • add_data()
• bidsbuilder.modules.file_bases.json_files
  • JSON_check_schema()
  • JSON_shema_checker
    • JSON_shema_checker.check_schema()
    • JSON_shema_checker.check_tags()
  • JSONfile
    • JSONfile.__init__()
    • JSONfile.create()
    • JSONfile.delete_self()
    • JSONfile.exists
    • JSONfile.filename
    • JSONfile.metadata
    • JSONfile.rawMetadata
  • agnostic_JSONfile
    • agnostic_JSONfile.__init__()
    • agnostic_JSONfile.create()
    • agnostic_JSONfile.delete_self()
    • agnostic_JSONfile.exists
    • agnostic_JSONfile.filename
    • agnostic_JSONfile.metadata
    • agnostic_JSONfile.rawMetadata
  • extra_JSONfile
    • extra_JSONfile.__init__()
    • extra_JSONfile.create()
    • extra_JSONfile.delete_self()
    • extra_JSONfile.exists
    • extra_JSONfile.filename
    • extra_JSONfile.metadata
    • extra_JSONfile.rawMetadata
  • metadataDict
    • metadataDict.__init__()
    • metadataDict.clear()
    • metadataDict.del_metadata()
    • metadataDict.forbidden_instance_names
    • metadataDict.get()
    • metadataDict.items()
    • metadataDict.keys()
    • metadataDict.pop()
    • metadataDict.popitem()
    • metadataDict.set_metadata()
    • metadataDict.setdefault()
    • metadataDict.update()
    • metadataDict.values()
  • sidecar_JSONfile
    • sidecar_JSONfile.__init__()
    • sidecar_JSONfile.create()
    • sidecar_JSONfile.delete_self()
    • sidecar_JSONfile.exists
    • sidecar_JSONfile.filename
    • sidecar_JSONfile.metadata
    • sidecar_JSONfile.rawMetadata
• bidsbuilder.modules.file_bases.tabular_files
  • NOT_ALLOWED
  • columnView
    • columnView.__init__()
    • columnView.add()
    • columnView.clear()
    • columnView.col_names
    • columnView.data
    • columnView.data_schema
    • columnView.discard()
    • columnView.forbidden_instance_names
    • columnView.isdisjoint()
    • columnView.pop()
    • columnView.remove()
  • make_column_view()
  • stringify_all()
  • tableView
    • tableView.__init__()
    • tableView.addColumn()
    • tableView.addDataframe()
    • tableView.addRow()
    • tableView.addValues()
    • tableView.additional_columns_flag
    • tableView.columns
    • tableView.data
    • tableView.data_schema
    • tableView.delRow()
    • tableView.delValues()
    • tableView.isRow()
  • tabularFile
    • tabularFile.__init__()
    • tabularFile.addColumn()
    • tabularFile.addDataframe()
    • tabularFile.addRow()
    • tabularFile.addValues()
    • tabularFile.columns
    • tabularFile.create()
    • tabularFile.data
    • tabularFile.delRow()
    • tabularFile.delValues()
    • tabularFile.delete_self()
    • tabularFile.exists
    • tabularFile.filename
    • tabularFile.isRow()
    • tabularFile.json_sidecar
  • tabularJSONFile
    • tabularJSONFile.__init__()
    • tabularJSONFile.create()
    • tabularJSONFile.delete_self()
    • tabularJSONFile.exists
    • tabularJSONFile.filename
• bidsbuilder.modules.schema_objects
  • Column
    • Column.Delimiter
    • Column.__init__()
    • Column.description
    • Column.display_name
    • Column.format
    • Column.level
    • Column.name
    • Column.schema
    • Column.str_name
    • Column.type
    • Column.val
    • Column.val_checker()
    • Column.valid_types
    • Column.validate_object()
    • Column.vectorized_val_checker()
  • Entity
    • Entity.__init__()
    • Entity.description
    • Entity.display_name
    • Entity.format
    • Entity.level
    • Entity.name
    • Entity.schema
    • Entity.str_name
    • Entity.type
    • Entity.val
    • Entity.valid_types
    • Entity.validate_object()
  • Metadata
    • Metadata.__init__()
    • Metadata.description
    • Metadata.display_name
    • Metadata.format
    • Metadata.level
    • Metadata.name
    • Metadata.schema
    • Metadata.str_name
    • Metadata.type
    • Metadata.val
    • Metadata.valid_types
    • Metadata.validate_object()
  • Suffix
    • Suffix.__init__()
    • Suffix.description
    • Suffix.display_name
    • Suffix.name
    • Suffix.schema
    • Suffix.str_name
    • Suffix.validate_object()
  • UserDefinedColumn
    • UserDefinedColumn.Delimiter
    • UserDefinedColumn.Description
    • UserDefinedColumn.Format
    • UserDefinedColumn.HED
    • UserDefinedColumn.Levels
    • UserDefinedColumn.LongName
    • UserDefinedColumn.Maximum
    • UserDefinedColumn.Minimum
    • UserDefinedColumn.TermURL
    • UserDefinedColumn.Units
    • UserDefinedColumn.__init__()
    • UserDefinedColumn.create()
    • UserDefinedColumn.name
    • UserDefinedColumn.val_checker()
    • UserDefinedColumn.vectorized_val_checker()
  • raw_Datatype
    • raw_Datatype.__init__()
    • raw_Datatype.description
    • raw_Datatype.display_name
    • raw_Datatype.name
    • raw_Datatype.schema
    • raw_Datatype.str_name
    • raw_Datatype.validate_object()
• bidsbuilder.schema.interpreter.evaluation_funcs
  • allequal()
  • count()
  • exists()
  • index()
  • intersects()
  • length()
  • max()
  • min()
  • nMatch()
  • nSorted()
  • nType()
  • substr()
• bidsbuilder.schema.interpreter.fields_funcs
  • associations()
  • columns()
  • dataset()
  • datatype()
  • entities()
  • extension()
  • gzip()
  • json()
  • modality()
  • nifti_header()
  • ome()
  • path()
  • schema()
  • sidecar()
  • subject()
  • suffix()
  • tiff()
• bidsbuilder.schema.interpreter.operator_funcs
  • contains()
  • get_list_index()
  • get_property()
  • notImplemented()
  • op_and()
  • op_or()
  • wrap_list()
• bidsbuilder.schema.interpreter.selectors
  • SelectorParser
    • SelectorParser.ADD_OPS
    • SelectorParser.EQ_OPS
    • SelectorParser.EVAL_FUNCS
    • SelectorParser.FIELDS_MAP
    • SelectorParser.LOGIC_OPS
    • SelectorParser.MULT_OPS
    • SelectorParser.POSTFIX_OPS
    • SelectorParser.UNARY_OPS
    • SelectorParser.__init__()
    • SelectorParser.additive_term()
    • SelectorParser.advance()
    • SelectorParser.boolean()
    • SelectorParser.brackets()
    • SelectorParser.cur_token
    • SelectorParser.equality_term()
    • SelectorParser.from_raw()
    • SelectorParser.identifier()
    • SelectorParser.logic_term()
    • SelectorParser.match()
    • SelectorParser.mult_term()
    • SelectorParser.nanToken
    • SelectorParser.next_token
    • SelectorParser.number()
    • SelectorParser.p_float()
    • SelectorParser.parentheses()
    • SelectorParser.parse()
    • SelectorParser.postfix_term()
    • SelectorParser.prev_token
    • SelectorParser.primary()
    • SelectorParser.string()
    • SelectorParser.tok_regex
    • SelectorParser.token_specification
    • SelectorParser.tokenizer()
    • SelectorParser.unary_term()
  • selectorFunc
    • selectorFunc.__init__()
    • selectorFunc.args
    • selectorFunc.evaluate_static_nodes()
    • selectorFunc.is_callable
    • selectorFunc.requires_input
    • selectorFunc.tags
    • selectorFunc.val
  • selectorHook
    • selectorHook.__init__()
    • selectorHook.from_raw()
    • selectorHook.funcs
    • selectorHook.original
    • selectorHook.tags
  • token
    • token.__init__()
    • token.kind
    • token.val
• bidsbuilder.schema.schema
  • filter_schema()
  • interpret_schema()
  • parse_load_schema()
  • recursive_interpret()
• bidsbuilder.schema.schema_checking
  • check_schema()
• bidsbuilder.util.categoryDict
  • WatchableDict
    • WatchableDict.__init__()
    • WatchableDict.get()
    • WatchableDict.items()
    • WatchableDict.keys()
    • WatchableDict.on_change()
  • categoryDict
    • categoryDict.CATEGORY
    • categoryDict.VALUE
    • categoryDict.__init__()
    • categoryDict.items()
    • categoryDict.keys()
    • categoryDict.pop()
    • categoryDict.values()
• bidsbuilder.util.dictview
  • dictview
• bidsbuilder.util.hooks.containers
  • MinimalDict
    • MinimalDict.__init__()
    • MinimalDict.clear()
    • MinimalDict.forbidden_instance_names
    • MinimalDict.get()
    • MinimalDict.items()
    • MinimalDict.keys()
    • MinimalDict.pop()
    • MinimalDict.popitem()
    • MinimalDict.setdefault()
    • MinimalDict.update()
    • MinimalDict.values()
  • MinimalList
    • MinimalList.__init__()
    • MinimalList.append()
    • MinimalList.clear()
    • MinimalList.count()
    • MinimalList.extend()
    • MinimalList.forbidden_instance_names
    • MinimalList.index()
    • MinimalList.insert()
    • MinimalList.pop()
    • MinimalList.remove()
    • MinimalList.reverse()
  • MinimalSet
    • MinimalSet.__init__()
    • MinimalSet.add()
    • MinimalSet.clear()
    • MinimalSet.discard()
    • MinimalSet.forbidden_instance_names
    • MinimalSet.isdisjoint()
    • MinimalSet.pop()
    • MinimalSet.remove()
  • is_supported_type()
  • wrap_container()
• bidsbuilder.util.hooks.descriptors
  • CallbackBase
    • CallbackBase.__init__()
  • CallbackGetterMixin
    • CallbackGetterMixin.__init__()
  • CallbackNoGetterMixin
  • DescriptorProtocol
    • DescriptorProtocol.__init__()
    • DescriptorProtocol.name
  • HookedDescriptor()
  • PerInstanceCallbackMixin
    • PerInstanceCallbackMixin.__init__()
    • PerInstanceCallbackMixin.add_callback()
  • PlainMixin
  • PlainValMixin
    • PlainValMixin.__init__()
  • SingleCallbackMixin
    • SingleCallbackMixin.__init__()
  • callbackKwargs
    • callbackKwargs.__init__()
    • callbackKwargs.__new__()
    • callbackKwargs.callback
    • callbackKwargs.clear()
    • callbackKwargs.copy()
    • callbackKwargs.default
    • callbackKwargs.factory
    • callbackKwargs.fget
    • callbackKwargs.fromkeys()
    • callbackKwargs.fval
    • callbackKwargs.get()
    • callbackKwargs.items()
    • callbackKwargs.keys()
    • callbackKwargs.pop()
    • callbackKwargs.popitem()
    • callbackKwargs.setdefault()
    • callbackKwargs.tags
    • callbackKwargs.update()
    • callbackKwargs.values()
• bidsbuilder.util.hooks.meta
  • Observable
    • Observable.__init__()
  • ObservableMeta
    • ObservableMeta.__init__()
    • ObservableMeta.__new__()
    • ObservableMeta.mro()
  • make_observable_type()
• bidsbuilder.util.hooks.test_containers
  • MinimalDict
    • MinimalDict.__init__()
    • MinimalDict.clear()
    • MinimalDict.forbidden_instance_names
    • MinimalDict.get()
    • MinimalDict.items()
    • MinimalDict.keys()
    • MinimalDict.pop()
    • MinimalDict.popitem()
    • MinimalDict.setdefault()
    • MinimalDict.update()
    • MinimalDict.values()
  • MinimalList
    • MinimalList.__init__()
    • MinimalList.append()
    • MinimalList.clear()
    • MinimalList.count()
    • MinimalList.extend()
    • MinimalList.forbidden_instance_names
    • MinimalList.index()
    • MinimalList.insert()
    • MinimalList.pop()
    • MinimalList.remove()
    • MinimalList.reverse()
  • MinimalSet
    • MinimalSet.__init__()
    • MinimalSet.add()
    • MinimalSet.clear()
    • MinimalSet.discard()
    • MinimalSet.forbidden_instance_names
    • MinimalSet.isdisjoint()
    • MinimalSet.pop()
    • MinimalSet.remove()
  • is_supported_type()
  • wrap_container()
• bidsbuilder.util.io
• bidsbuilder.util.util
  • checkPath()
  • clearSchema()
  • isDir()
  • popDict()
  • popDicts()