skeleton_keys.cmds.postprocess_features.PostprocessFeaturesParameters#

class skeleton_keys.cmds.postprocess_features.PostprocessFeaturesParameters(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)#

This schema is designed to be a schema_type for an ArgSchemaParser object

PostprocessFeaturesParameters#

key

description

default

field_type

json_type

input_json

file path of input json file

NA

InputFile

str

output_json

file path to output json file

NA

OutputFile

str

log_level

set the logging level of the module

ERROR

LogLevel

str

input_files

Long-form CSV files of morphology features

NA

List

str

wide_normalized_output_file

Wide-form CSV of normalized features

NA

OutputFile

str

wide_unnormalized_output_file

Wide-form CSV of un-normalized features

NA

OutputFile

str

drop_stem_exit

Whether to drop stem exit features

False

Boolean

bool

drop_bifurcation_angle

Whether to drop bifurcation angle features

False

Boolean

bool

drop_apical_n_stems

Whether to drop number of apical dendrite stems features

False

Boolean

bool

drop_neurite_radius_features

Whether to drop features that are calculated using the radius of neurite compartments.

False

Boolean

bool

drop_soma_surface_area

Whether to drop the soma surface area features

False

Boolean

bool

drop_nans

Whether to drop cells that have nan for any values

False

Boolean

bool

__init__(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)#

Methods

__init__(*[, only, exclude, many, context, ...])

dump(obj, *[, many])

Serialize an object to native Python data types according to this Schema's fields.

dumps(obj, *args[, many])

Same as dump(), except return a JSON-encoded string.

from_dict(fields, *[, name])

Generate a Schema class given a dictionary of fields.

get_attribute(obj, attr, default)

Defines how to pull values from an object to serialize.

handle_error(error, data, *, many, **kwargs)

Custom error handler function for the schema.

load(data, *[, many, partial, unknown])

Deserialize a data structure to an object defined by this Schema's fields.

loads(json_data, *[, many, partial, unknown])

Same as load(), except it takes a JSON string as input.

make_object(in_data, **kwargs)

marshmallow.pre_load decorated function for applying defaults on deserialation

on_bind_field(field_name, field_obj)

Hook to modify a field when it is bound to the Schema.

validate(data, *[, many, partial])

Validate data against the schema, returning a dictionary of validation errors.

Attributes

TYPE_MAPPING

dict_class

error_messages

Overrides for default schema-level error messages

opts

set_class