ipfx.bin package

Submodules

ipfx.bin.generate_fx_input module

ipfx.bin.generate_fx_input.generate_fx_input(se_input, se_output, cell_dir, plot_figures=False)[source]
ipfx.bin.generate_fx_input.main()[source]

Usage: > python generate_fx_input.py –specimen_id SPECIMEN_ID –cell_dir CELL_DIR > python generate_fx_input.py –input_nwb_file INPUT_NWB_FILE –cell_dir CELL_DIR

ipfx.bin.generate_pipeline_input module

ipfx.bin.generate_pipeline_input.generate_pipeline_input(cell_dir=None, specimen_id=None, input_nwb_file=None, plot_figures=False)[source]
ipfx.bin.generate_pipeline_input.main()[source]

Usage: > python generate_pipeline_input.py –specimen_id SPECIMEN_ID –cell_dir CELL_DIR > python generate_pipeline_input.py –input_nwb_file INPUT_NWB_FILE –cell_dir CELL_DIR

ipfx.bin.generate_qc_input module

ipfx.bin.generate_qc_input.generate_qc_input(se_input, se_output)[source]
ipfx.bin.generate_qc_input.main()[source]

Usage: > python generate_qc_input.py –specimen_id SPECIMEN_ID –cell_dir CELL_DIR > python generate_qc_input.py –input_nwb_file input_nwb_file –cell_dir CELL_DIR

ipfx.bin.generate_se_input module

ipfx.bin.generate_se_input.generate_se_input(cell_dir, specimen_id=None, input_nwb_file=None)[source]
ipfx.bin.generate_se_input.main()[source]

Usage: > python generate_se_input.py –specimen_id SPECIMEN_ID –cell_dir CELL_DIR > python generate_se_input.py –input_nwb_file input_nwb_file –cell_dir CELL_DIR

ipfx.bin.generate_se_input.parse_args()[source]

ipfx.bin.get_fx_output module

ipfx.bin.get_fx_output.get_fx_output_json(specimen_id)[source]

Find in LIMS the full path to the json output of the feature extraction module If more than one file exists, then chose the latest version

System Message: SEVERE/4 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/get_fx_output.py:docstring of ipfx.bin.get_fx_output.get_fx_output_json, line 5)

Unexpected section title.

Parameters
----------

specimen_id

System Message: SEVERE/4 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/get_fx_output.py:docstring of ipfx.bin.get_fx_output.get_fx_output_json, line 9)

Unexpected section title.

Returns
-------

file_name: string

ipfx.bin.get_fx_output.main()[source]

Usage: $python get_fx_output.py –input_file IN_FILE –output_file OUT_FILE IN_FILE: name of the input file including a single column with the header ‘specimen_id’ OUT_FILE: name of the output file that includes columns ‘specimen_id’ and ‘fx_output_json’

ipfx.bin.get_fx_output.parse_args()[source]

ipfx.bin.make_stimulus_ontology module

ipfx.bin.make_stimulus_ontology.main()[source]
ipfx.bin.make_stimulus_ontology.make_default_stimulus_ontology()[source]
ipfx.bin.make_stimulus_ontology.make_stimulus_ontology(stims)[source]
ipfx.bin.make_stimulus_ontology.make_stimulus_ontology_from_lims(file_name)[source]

ipfx.bin.mcc_get_settings module

Code for interfacing with the Multi Clamp Commander application from Axon/Molecular Devices

class ipfx.bin.mcc_get_settings.DataGatherer[source]

Bases: object

Collect data from all available MCC amplifiers

getData(mcc)[source]

Return all MCC settings for all amplifiers as dictionary

class ipfx.bin.mcc_get_settings.MultiClampControl(dllPath=None)[source]

Bases: object

Class for interacting with the MultiClamp Commander from Axon/Molecular Devices

Usage:

```

System Message: WARNING/2 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/mcc_get_settings.py:docstring of ipfx.bin.mcc_get_settings.MultiClampControl, line 13); backlink

Inline literal start-string without end-string.

System Message: WARNING/2 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/mcc_get_settings.py:docstring of ipfx.bin.mcc_get_settings.MultiClampControl, line 13); backlink

Inline interpreted text or phrase reference start-string without end-string.

import mcc

m = mcc.MultiClampControl() UIDs = m.getUIDs() # output all found amplifiers m.selectUniqueID(next(iter(UIDs))) # select the first one (implicitly done by __init__) clampMode = m.GetMode() # return the clamp mode if m._handleError()[0]:

System Message: ERROR/3 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/mcc_get_settings.py:docstring of ipfx.bin.mcc_get_settings.MultiClampControl, line 13)

Unexpected indentation.
# handle error pass

System Message: WARNING/2 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/mcc_get_settings.py:docstring of ipfx.bin.mcc_get_settings.MultiClampControl, line 15)

Definition list ends without a blank line; unexpected unindent.

```

System Message: WARNING/2 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/mcc_get_settings.py:docstring of ipfx.bin.mcc_get_settings.MultiClampControl, line 15); backlink

Inline literal start-string without end-string.

System Message: WARNING/2 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/mcc_get_settings.py:docstring of ipfx.bin.mcc_get_settings.MultiClampControl, line 15); backlink

Inline interpreted text or phrase reference start-string without end-string.
AutoBridgeBal()[source]
AutoFastComp()[source]
AutoLeakSub()[source]
AutoOutputZero()[source]
AutoPipetteOffset()[source]
AutoSlowComp()[source]
AutoWholeCellComp()[source]
BuildErrorText()[source]
Buzz()[source]
CheckAPIVersion()[source]
ClearMinus()[source]
ClearPlus()[source]
CreateObject()[source]

run this first to create self.hMCCmsg

DestroyObject()[source]

Do this last if you do it

FindFirstMultiClamp()[source]

Find the first available amplifier and return its parameter

FindNextMultiClamp()[source]

Find the next available amplifier and return its parameter

GetBridgeBalEnable()[source]
GetBridgeBalResist()[source]
GetBuzzDuration()[source]
GetFastCompCap()[source]
GetFastCompTau()[source]
GetHolding()[source]
GetHoldingEnable()[source]
GetLeakSubEnable()[source]
GetLeakSubResist()[source]
GetMeterIrmsEnable()[source]
GetMeterResistEnable()[source]
GetMeterValue(u)[source]
GetMode()[source]
GetModeSwitchEnable()[source]
GetNeutralizationCap()[source]
GetNeutralizationEnable()[source]
GetOscKillerEnable()[source]
GetOutputZeroAmplitude()[source]
GetOutputZeroEnable()[source]
GetPipetteOffset()[source]
GetPrimarySignal()[source]
GetPrimarySignalGain()[source]
GetPrimarySignalHPF()[source]
GetPrimarySignalLPF()[source]
GetPulseAmplitude()[source]
GetPulseDuration()[source]
GetRsCompBandwidth()[source]
GetRsCompCorrection()[source]
GetRsCompEnable()[source]
GetRsCompPrediction()[source]
GetScopeSignalLPF()[source]
GetSecondarySignal()[source]
GetSecondarySignalGain()[source]
GetSecondarySignalLPF()[source]
GetSlowCompCap()[source]
GetSlowCompTau()[source]
GetSlowCompTauX20Enable()[source]
GetSlowCurrentInjEnable()[source]
GetSlowCurrentInjLevel()[source]
GetSlowCurrentInjSettlingTime()[source]
GetTestSignalAmplitude()[source]
GetTestSignalEnable()[source]
GetTestSignalFrequency()[source]
GetWholeCellCompCap()[source]
GetWholeCellCompEnable()[source]
GetWholeCellCompResist()[source]
GetZapDuration()[source]
Pulse()[source]
QuickSelectButton(u)[source]
Reset()[source]
SelectMultiClamp(uModel, _pszSerialNum, uCOMPortID, uDeviceID, uChannelID)[source]
SetBridgeBalEnable(b)[source]
SetBridgeBalResist(d)[source]
SetBuzzDuration(d)[source]
SetFastCompCap(d)[source]
SetFastCompTau(d)[source]
SetHolding(d)[source]
SetHoldingEnable(b)[source]
SetLeakSubEnable(b)[source]
SetLeakSubResist(d)[source]
SetMeterIrmsEnable(b)[source]
SetMeterResistEnable(b)[source]
SetMode(u)[source]
SetModeSwitchEnable(b)[source]
SetNeutralizationCap(d)[source]
SetNeutralizationEnable(b)[source]
SetOscKillerEnable(b)[source]
SetOutputZeroAmplitude(d)[source]
SetOutputZeroEnable(b)[source]
SetPipetteOffset(d)[source]
SetPrimarySignal(u)[source]
SetPrimarySignalGain(d)[source]
SetPrimarySignalHPF(d)[source]
SetPrimarySignalLPF(d)[source]
SetPulseAmplitude(d)[source]
SetPulseDuration(d)[source]
SetRsCompBandwidth(d)[source]
SetRsCompCorrection(d)[source]
SetRsCompEnable(b)[source]
SetRsCompPrediction(d)[source]
SetScopeSignalLPF(d)[source]
SetSecondarySignal(u)[source]
SetSecondarySignalGain(d)[source]
SetSecondarySignalLPF(d)[source]
SetSlowCompCap(d)[source]
SetSlowCompTau(d)[source]
SetSlowCompTauX20Enable(b)[source]
SetSlowCurrentInjEnable(b)[source]
SetSlowCurrentInjLevel(d)[source]
SetSlowCurrentInjSettlingTime(d)[source]
SetTestSignalAmplitude(d)[source]
SetTestSignalEnable(b)[source]
SetTestSignalFrequency(d)[source]
SetTimeOut(u)[source]
SetWholeCellCompCap(d)[source]
SetWholeCellCompEnable(b)[source]
SetWholeCellCompResist(d)[source]
SetZapDuration(d)[source]
ToggleAlwaysOnTop()[source]
ToggleResize()[source]
Zap()[source]
cleanup()[source]
getChannel()[source]
getSerial()[source]
getUIDs()[source]

Return a list of all amplifier UIDs

selectUniqueID(uniqueID)[source]
class ipfx.bin.mcc_get_settings.SettingsFetcher(settingsFile)[source]

Bases: watchdog.events.RegexMatchingEventHandler

on_created(event)[source]

Called when a file or directory is created.

Parameters:event (DirCreatedEvent or FileCreatedEvent) – Event representing file/directory creation.
ipfx.bin.mcc_get_settings.c_bool_p

alias of ipfx.bin.mcc_get_settings.LP_c_bool

ipfx.bin.mcc_get_settings.c_double_p

alias of ipfx.bin.mcc_get_settings.LP_c_double

ipfx.bin.mcc_get_settings.c_uint_p

alias of ipfx.bin.mcc_get_settings.LP_c_uint

ipfx.bin.mcc_get_settings.main()[source]
ipfx.bin.mcc_get_settings.parseSettingsFromFile(settingsFile)[source]
ipfx.bin.mcc_get_settings.val(ptr, ptype)[source]
ipfx.bin.mcc_get_settings.writeSettingsToFile(settingsFile, filename)[source]

ipfx.bin.nwb_to_pdf module

class ipfx.bin.nwb_to_pdf.PatchClampSeriesPlotData(pcs)[source]

Bases: object

Data class for storing plotting information for PatchClampSeries
pcs: neurodata patchClampSeries or derived object
add_annotation(name, data, unit)[source]
check_type(type_)[source]
get_annotation()[source]
class ipfx.bin.nwb_to_pdf.SingleSweep(id)[source]

Bases: object

Generic Class for storing sweep specific PatchClampSeries Data

add_acquisition(key, pcs)[source]
add_stimulus(key, pcs)[source]
get_acquisition()[source]
get_stimulus()[source]
num_acquisition()[source]
num_stimulus()[source]
class ipfx.bin.nwb_to_pdf.SweepCollection[source]

Bases: object

Class for grouping sweep related PatchClampSeries

get(id)[source]
ipfx.bin.nwb_to_pdf.check_stimset_reconstruction(nwbfile, outfile)[source]

From a specially crafted NWB file this routine creates a PDF for checking the stimset reconstruction.

The NWB file must have data acquired on two headstages/electrodes where the second just reads back the stimulus set.

ipfx.bin.nwb_to_pdf.create_regular_pdf(nwbfile, outfile)[source]

convert a NeurodataWithoutBorders file to a PortableDocumentFile

ipfx.bin.nwb_to_pdf.gather_sweeps(nwbfile)[source]

sort PatchClampSeries according to cycle_id

ipfx.bin.nwb_to_pdf.main()[source]
ipfx.bin.nwb_to_pdf.physical(number, unit)[source]
ipfx.bin.nwb_to_pdf.plot_patchClampSeries(axis, pcs_data_plot, length)[source]
plot a PatchClampSeries against the axis
pcs_data_plot: class PatchClampSeriesPlotData axis: plt.axis length: number of points to plot
ipfx.bin.nwb_to_pdf.plot_sweepdata(sweepdata, axes, length, addXTicks=False)[source]
plot the given sweep data (stimulus or acquisition) on the given axes
sweepdata: dict(class PatchClampSeriesPlotData) (either acquisition or
stimulus)

System Message: WARNING/2 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/nwb_to_pdf.py:docstring of ipfx.bin.nwb_to_pdf.plot_sweepdata, line 4)

Definition list ends without a blank line; unexpected unindent.

axes: np.ndarray(plt.axis) length: number of points to plot addXTicks: Add ticks and a label to the X axis at the bottom

ipfx.bin.nwb_to_pdf.to_si(d, sep=' ')[source]

taken from https://stackoverflow.com/a/15734251/7809404

Convert number to string with SI prefix

Example: 
>>> to_si(2500.0)
'2.5 k'

>>> to_si(2.3E6)
'2.3 M'

>>> to_si(2.3E-6)
'2.3 µ'

>>> to_si(-2500.0)
'-2.5 k'

>>> to_si(0)
'0'

ipfx.bin.pipeline_from_specimen_id module

ipfx.bin.pipeline_from_specimen_id.main()[source]

Runs pipeline from the specimen_id Usage: python pipeline_from_nwb_file.py SPECIMEN_ID

User must specify the OUTPUT_DIR

ipfx.bin.plot_ephys_nwb module

ipfx.bin.plot_ephys_nwb.axes_ratios(sweep_table)[source]
ipfx.bin.plot_ephys_nwb.customize_axis(ax)[source]
ipfx.bin.plot_ephys_nwb.get_vertical_offset(data)[source]
ipfx.bin.plot_ephys_nwb.main()[source]

Plot sweeps of a given ephys nwb file # Usage: $ python plot_ephys_nwb_file.py NWB_FILE_NAME

ipfx.bin.plot_ephys_nwb.plot_data_set(data_set, sweep_table, nwb_file_name)[source]
ipfx.bin.plot_ephys_nwb.plot_waveforms(ax, ys, rs, sn)[source]

ipfx.bin.run_chirp_fv_extraction module

class ipfx.bin.run_chirp_fv_extraction.CollectChirpFeatureVectorParameters(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]

Bases: argschema.schemas.ArgSchema

opts = <marshmallow.schema.SchemaOpts object>
ipfx.bin.run_chirp_fv_extraction.data_for_specimen_id(specimen_id, data_source, ontology)[source]
ipfx.bin.run_chirp_fv_extraction.edit_ontology_data(original_ontology_data, codes_to_rename, new_name_tag, new_core_tag)[source]
ipfx.bin.run_chirp_fv_extraction.main(output_dir, output_code, input_file, include_failed_cells, run_parallel, data_source, chirp_stimulus_codes, **kwargs)[source]
ipfx.bin.run_chirp_fv_extraction.run_chirp_feature_vector_extraction(output_dir, output_code, include_failed_cells, specimen_ids, chirp_stimulus_codes, data_source='lims', run_parallel=True)[source]

ipfx.bin.run_feature_collection module

class ipfx.bin.run_feature_collection.CollectFeatureParameters(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]

Bases: argschema.schemas.ArgSchema

opts = <marshmallow.schema.SchemaOpts object>
ipfx.bin.run_feature_collection.data_for_specimen_id(specimen_id, passed_only, data_source, ontology, file_list=None)[source]
ipfx.bin.run_feature_collection.extract_features(data_set, ramp_sweep_numbers, ssq_sweep_numbers, lsq_sweep_numbers, amp_interval=20, max_above_rheo=100)[source]
ipfx.bin.run_feature_collection.fi_curve_fit(amps, rates)[source]
ipfx.bin.run_feature_collection.first_spike_lsq(spike_data, feature_list=['threshold_v', 'peak_v', 'upstroke', 'downstroke', 'upstroke_downstroke_ratio', 'width', 'fast_trough_v'])[source]
ipfx.bin.run_feature_collection.first_spike_ramp(ramp_analyzer, feature_list=['threshold_v', 'peak_v', 'upstroke', 'downstroke', 'upstroke_downstroke_ratio', 'width', 'fast_trough_v'])[source]
ipfx.bin.run_feature_collection.first_spike_ssq(ssq_analyzer, feature_list=['threshold_v', 'peak_v', 'upstroke', 'downstroke', 'upstroke_downstroke_ratio', 'width', 'fast_trough_v'])[source]
ipfx.bin.run_feature_collection.lin_sqrt_fit(x, y)[source]
ipfx.bin.run_feature_collection.main()[source]
ipfx.bin.run_feature_collection.mean_spike_lsq(spike_data, feature_list=['threshold_v', 'peak_v', 'upstroke', 'downstroke', 'upstroke_downstroke_ratio', 'width', 'fast_trough_v'])[source]
ipfx.bin.run_feature_collection.run_feature_collection(ids=None, project='T301', include_failed_sweeps=True, include_failed_cells=False, output_file='', run_parallel=True, data_source='lims', file_list=None, **kwargs)[source]
ipfx.bin.run_feature_collection.sqrt_curve(x, A, Ic)[source]

ipfx.bin.run_feature_extraction module

ipfx.bin.run_feature_extraction.collect_spike_times(sweep_features)[source]
ipfx.bin.run_feature_extraction.main()[source]

Usage: python run_feature_extraction.py –input_json INPUT_JSON –output_json OUTPUT_JSON

ipfx.bin.run_feature_extraction.run_feature_extraction(input_nwb_file, stimulus_ontology_file, output_nwb_file, qc_fig_dir, sweep_info, cell_info)[source]

ipfx.bin.run_feature_vector_extraction module

class ipfx.bin.run_feature_vector_extraction.CollectFeatureVectorParameters(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)[source]

Bases: argschema.schemas.ArgSchema

opts = <marshmallow.schema.SchemaOpts object>
ipfx.bin.run_feature_vector_extraction.data_for_specimen_id(specimen_id, sweep_qc_option, data_source, ontology, ap_window_length=0.005, target_sampling_rate=50000, file_list=None)[source]

Extract feature vector from given cell identified by the specimen_id Parameters ———- specimen_id : int

System Message: ERROR/3 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_feature_vector_extraction.py:docstring of ipfx.bin.run_feature_vector_extraction.data_for_specimen_id, line 5)

Unexpected indentation.
cell identified

System Message: WARNING/2 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_feature_vector_extraction.py:docstring of ipfx.bin.run_feature_vector_extraction.data_for_specimen_id, line 6)

Block quote ends without a blank line; unexpected unindent.
sweep_qc_option : str
see CollectFeatureVectorParameters input schema for details
data_source: str
see CollectFeatureVectorParameters input schema for details
ontology : stimulus.StimulusOntology
mapping of stimuli names to stimulus codes
ap_window_length : float
see CollectFeatureVectorParameters input schema for details
target_sampling_rate : float
sampling rate
file_list : list of str
nwbfile names

System Message: WARNING/2 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_feature_vector_extraction.py:docstring of ipfx.bin.run_feature_vector_extraction.data_for_specimen_id, line 18)

Definition list ends without a blank line; unexpected unindent.

System Message: SEVERE/4 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_feature_vector_extraction.py:docstring of ipfx.bin.run_feature_vector_extraction.data_for_specimen_id, line 19)

Unexpected section title.

Returns
-------
dict :
features for a given cell specimen_id
ipfx.bin.run_feature_vector_extraction.main()[source]
ipfx.bin.run_feature_vector_extraction.run_feature_vector_extraction(output_dir, data_source, output_code, project, output_file_type, sweep_qc_option, include_failed_cells, run_parallel, ap_window_length, ids=None, file_list=None, **kwargs)[source]

Extract feature vector from a list of cells and save result to the output file(s)

System Message: SEVERE/4 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_feature_vector_extraction.py:docstring of ipfx.bin.run_feature_vector_extraction.run_feature_vector_extraction, line 4)

Unexpected section title.

Parameters
----------
output_dir : str
see CollectFeatureVectorParameters input schema for details
data_source : str
see CollectFeatureVectorParameters input schema for details
output_code: str
see CollectFeatureVectorParameters input schema for details
project : str
see CollectFeatureVectorParameters input schema for details
output_file_type : str
see CollectFeatureVectorParameters input schema for details
sweep_qc_option: str
see CollectFeatureVectorParameters input schema for details
include_failed_cells: bool
see CollectFeatureVectorParameters input schema for details
run_parallel: bool
see CollectFeatureVectorParameters input schema for details
ap_window_length: float
see CollectFeatureVectorParameters input schema for details
ids: int
ids associated to each cell.
file_list: list of str
nwbfile names

System Message: WARNING/2 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_feature_vector_extraction.py:docstring of ipfx.bin.run_feature_vector_extraction.run_feature_vector_extraction, line 27)

Definition list ends without a blank line; unexpected unindent.

kwargs

System Message: SEVERE/4 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_feature_vector_extraction.py:docstring of ipfx.bin.run_feature_vector_extraction.run_feature_vector_extraction, line 30)

Unexpected section title.

Returns
-------

ipfx.bin.run_pipeline module

ipfx.bin.run_pipeline.main()[source]

Usage: python run_pipeline.py –input_json INPUT_JSON –output_json OUTPUT_JSON

ipfx.bin.run_pipeline.run_pipeline(input_nwb_file, output_nwb_file, stimulus_ontology_file, qc_fig_dir, qc_criteria, manual_sweep_states)[source]

ipfx.bin.run_pipeline_from_nwb_file module

ipfx.bin.run_pipeline_from_nwb_file.main()[source]

Convenience script for running ephys pipeline from a given nwb file It generates the pipeline input and then calls the run_pipeline executable

Usage: python run_pipeline_from_nwb_file.py <input_nwb_file> <output_dir>

ipfx.bin.run_qc module

ipfx.bin.run_qc.main()[source]

Usage: python run_qc.py –input_json INPUT_JSON –output_json OUTPUT_JSON

ipfx.bin.run_qc.qc_summary(sweep_features, sweep_states, cell_features, cell_state)[source]

Output QC summary

System Message: SEVERE/4 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_qc.py:docstring of ipfx.bin.run_qc.qc_summary, line 4)

Unexpected section title.

Parameters
----------

sweep_features: list of dicts sweep_states: list of dict cell_features: list of dicts cell_state: dict

System Message: SEVERE/4 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_qc.py:docstring of ipfx.bin.run_qc.qc_summary, line 11)

Unexpected section title.

Returns
-------
ipfx.bin.run_qc.run_qc(stimulus_ontology_file, cell_features, sweep_features, qc_criteria)[source]

System Message: SEVERE/4 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_qc.py:docstring of ipfx.bin.run_qc.run_qc, line 2)

Unexpected section title.

Parameters
----------
stimulus_ontology_file : str
ontology file name
cell_features: dict
cell features
sweep_features : list of dicts
sweep features
qc_criteria: dict
qc criteria

System Message: SEVERE/4 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_qc.py:docstring of ipfx.bin.run_qc.run_qc, line 13)

Unexpected section title.

Returns
-------
dict
containing state of the cell and sweeps

ipfx.bin.run_sweep_extraction module

ipfx.bin.run_sweep_extraction.main()[source]

Usage: python run_sweep_extraction.py

System Message: ERROR/3 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_sweep_extraction.py:docstring of ipfx.bin.run_sweep_extraction.main, line 3)

Unexpected indentation.
–input_json INPUT_JSON –output_json OUTPUT_JSON
ipfx.bin.run_sweep_extraction.run_sweep_extraction(input_nwb_file, stimulus_ontology_file, input_manual_values=None)[source]

System Message: SEVERE/4 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_sweep_extraction.py:docstring of ipfx.bin.run_sweep_extraction.run_sweep_extraction, line 2)

Unexpected section title.

Parameters
----------

input_nwb_file stimulus_ontology_file input_manual_values

System Message: SEVERE/4 (/home/docs/checkouts/readthedocs.org/user_builds/ipfx/checkouts/v1.0.0.1/ipfx/bin/run_sweep_extraction.py:docstring of ipfx.bin.run_sweep_extraction.run_sweep_extraction, line 8)

Unexpected section title.

Returns
-------

ipfx.bin.run_synphys_feature_vector_extraction module

ipfx.bin.run_x_to_nwb_conversion module

ipfx.bin.run_x_to_nwb_conversion.convert(inFileOrFolder, overwrite=False, fileType=None, outputMetadata=False, outputFeedbackChannel=False, multipleGroupsPerFile=False, compression=True)[source]

Convert the given file to a NeuroDataWithoutBorders file using pynwb

Supported fileformats:
  • ABF v2 files created by Clampex
  • DAT files created by Patchmaster v2x90
Parameters:
  • inFileOrFolder – path to a file or folder
  • overwrite – overwrite output file, defaults to False
  • fileType – file type to be converted, must be passed iff inFileOrFolder refers to a folder
  • outputMetadata – output metadata of the file, helpful for debugging
  • outputFeedbackChannel – Output ADC data which stems from stimulus feedback channels (ignored for DAT files)
  • multipleGroupsPerFile – Write all Groups in the DAT file into one NWB file. By default we create one NWB per Group (ignored for ABF files).
  • compression – Toggle compression for HDF5 datasets
Returns:

path of the created NWB file
ipfx.bin.run_x_to_nwb_conversion.main()[source]

ipfx.bin.validate_experiment module

ipfx.bin.validate_experiment.get_pipeline_output_json(storage_dir, err_id)[source]

Return the name of the output file giving preference to the newer version Parameters ———- storage_dir: str of storage directory err_id: str err_id Returns ——- pipeline_output_json: str filename

ipfx.bin.validate_experiment.main()[source]
ipfx.bin.validate_experiment.nullisclose(a, b)[source]
ipfx.bin.validate_experiment.validate_cell_features(err, ephys_features, cell_record)[source]
ipfx.bin.validate_experiment.validate_feature_set(features, d1, d2)[source]
ipfx.bin.validate_experiment.validate_fx(test_output_json='test/fx_output.json')[source]
ipfx.bin.validate_experiment.validate_pipeline(input_json, output_json)[source]
ipfx.bin.validate_experiment.validate_run_completion(pipeline_input_json, pipeline_output_json)[source]

Check if the pipeline output was generated as way of confirming that the run completed Parameters ———- pipeline_input_json pipeline_output_json Returns ——-

ipfx.bin.validate_experiment.validate_se(test_output_json='test/sweep_extraction_output.json')[source]

Module contents