MatchingData.set_matching_dimension#

MatchingData.set_matching_dimension(target_dim=None, template_dim=None)[source]#

Sets matching dimensions for target and template.

Parameters:
target_dimint, optional

Target batch dimension, None by default.

template_dimint, optional

Template batch dimension, None by default.

Notes

If target and template share a batch dimension, the target will take precendence and the template dimension will be shifted to the right. If target and template have the same dimension, but target specifies batch dimensions, the leftmost template dimensions are assumed to be collapse dimensions.

Examples

>>> matching_data.set_matching_dimension(target_dim=0, template_dim=None)