Documentation API of the 'hep.aida.IFitData' Java class
IFitData
hep.aida

Interface IFitData

  • All Known Subinterfaces:
    IDevFitData
    All Known Implementing Classes:
    FitData


    public interface IFitData
    Abstract representation of the fit data. Serves for several purposes: - decouple fitter from the details of the particular data objects (Histograms etc) - provide range restriction capability ("cut of the tails...") - creates the image of the virtual data source Design notes: 1) we try to be explicit in the method names which should indicate the dimensionality of the fit data. this way we have more compile-time/run-time safety and clearer code. in C++ we can handle default arguments which otherwise would be ambigeous. 2) string names of the arguments are at the end of the methods' signatures and have default (empty) values. so if function argument name is missing, assume the ordering is taken from the histogram axis it connects to the name of the pipes then are generated automatically using the same default scheme as for functions x[1], x[2] etc. 3) There are two ends to pipes: one connected to the data source and one pouring data out. Both their orders has to be specified. For IHistogram, ICloud, IProfile the connections to the data source are ordered as the axis (x=0, y=1, z=2); the user has to provide the order with which the pipes are providing the data. So for example in the constructor create2DConnection(hist2D,xIndex,yIndex); xIndex specifies the exit order of the pipe connected to the x Axis (and similarly for yIndex). So the default method create2DConnection(hist2D); corresponds to create2DConnection(hist2D,0,1); In the methods for IHistograms, IClouds, and IProfiles one index could have been dropped as the second could be inferred by the dimensionality. We preferred being redundant just to avoid confusion in interpreting what create2DConnection(hist2D,1); really means. For ITuple and IDataPointSet the order in the connection to the data source is specified by the user by providing, respectively, the array of column names (or evaluators) and the array of coordinate indexes to which to connect the pipes. In this case we assume that the pipes are parallel, i.e. the exit order is the same as the one of the connection to the data source. In the createXDConnection methods to IDataPointSets we preferred not to provide defaults for the valIndex to avoid confusion in interpreting it. We can always add it later. PENDING: clarify the relation between data range and normalization range

Warning: You cannot see the full API documentation of this class since the access to the DatMelt documentation for third-party Java classes is denied. Guests can only view jhplot Java API. To view the complete description of this class and its methods, please request the full DataMelt membership.

If you are already a full member, please login to the DataMelt member area before visiting this documentation.