File: regularity_eval_to_selection.Rd

package info (click to toggle)
r-cran-hdf5r 1.3.8%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 10,192 kB
  • sloc: ansic: 76,883; sh: 82; python: 32; makefile: 13
file content (28 lines) | stat: -rw-r--r-- 1,093 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/high_level_UI.R
\name{regularity_eval_to_selection}
\alias{regularity_eval_to_selection}
\title{Turn regulation evaluation into a selection for a space object}
\usage{
regularity_eval_to_selection(reg_eval_res)
}
\arguments{
\item{reg_eval_res}{The result of the \code{args_regularity_evaluation} function}
}
\value{
Returns an object with either the point-matrix or the hyperslab-selection array. The resulting object is
of class \code{point_selection} or \code{hyperslab_selection}.
}
\description{
Turn regulation evaluation into a selection for a space object
}
\details{
Analyzes the results of the regularity evaluation of each dimension and checks if
it needs to be into a hyperslab-selection or a point-selection. A hyperslab selection will be chosen
whenever there are significantly less of it than the number of selected points. The ratio is determined
by the option \code{hdf5r.point_to_hyperslab_ratio}. If this is 1, then always hyperslabs will be used.
}
\author{
Holger Hoefling
}
\keyword{internal}