File: H5P_DATASET_CREATE-class.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 (161 lines) | stat: -rw-r--r-- 6,325 bytes parent folder | download | duplicates (2)
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/R6Classes_H5P.R
\docType{class}
\name{H5P_DATASET_CREATE-class}
\alias{H5P_DATASET_CREATE-class}
\alias{H5P_DATASET_CREATE}
\title{Class for HDF5 property list for dataset creation}
\value{
Object of class \code{\link[=H5P_DATASET_CREATE]{H5P_DATASET_CREATE}}.
}
\description{
It inherits all functions of the \code{\link{H5P}}.
}
\section{Methods}{

\describe{
\item{\code{new(id = NULL)}}{

Create a new class of type \code{\link{H5P_DATASET_CREATE}}

\strong{Parameters}
\describe{
\item{id}{Internal use only}
}}

\item{\code{set_layout(layout = h5const$H5D_CHUNKED)}}{

This function implements the HDF5-API function H5Pset_layout.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_SET_LAYOUT} for details.}

\item{\code{get_layout()}}{

This function implements the HDF5-API function H5Pget_layout.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_GET_LAYOUT} for details.}

\item{\code{set_chunk(chunk)}}{

This function implements the HDF5-API function H5Pset_chunk.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_SET_CHUNK} for details.}

\item{\code{get_chunk(max_ndims)}}{

This function implements the HDF5-API function H5Pget_chunk.
If the layout is not chunked, returns NA.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_GET_CHUNK} for details.}

\item{\code{set_deflate(level)}}{

This function implements the HDF5-API function H5Pset_deflate.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_SET_DEFLATE} for details.}

\item{\code{set_fill_value(dtype, value)}}{

This function implements the HDF5-API function H5Pset_fill_value.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_SET_FILL_VALUE} for details.}

\item{\code{get_fill_value(dtype)}}{

This function implements the HDF5-API function H5Pget_fill_value.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_GET_FILL_VALUE} for details.}

\item{\code{set_fill_time(fill_time = h5const$H5D_FILL_TIME_IFSET)}}{

This function implements the HDF5-API function H5Pset_fill_time.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_SET_FILL_TIME} for details.}

\item{\code{get_fill_time()}}{

This function implements the HDF5-API function H5Pget_fill_time.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_GET_FILL_TIME} for details.}

\item{\code{set_alloc_time(alloc_time = h5const$H5D_ALLOC_TIME_DEFAULT)}}{

This function implements the HDF5-API function H5Pset_alloc_time.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_SET_ALLOC_TIME} for details.}

\item{\code{get_alloc_time()}}{

This function implements the HDF5-API function H5Pget_alloc_time.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_GET_ALLOC_TIME} for details.}

\item{\code{set_filter(filter = h5const$H5Z_FILTER_DEFLATE,
  flags = h5const$H5Z_FLAG_OPTIONAL, cd_values = integer(0))}}{

This function implements the HDF5-API function H5Pset_filter.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_SET_FILTER} for details.}

\item{\code{all_filters_avail()}}{

This function implements the HDF5-API function H5Pall_filters_avail.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_ALL_FILTERS_AVAIL} for details.}

\item{\code{get_nfilters()}}{

This function implements the HDF5-API function H5Pget_nfilters.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_GET_NFILTERS} for details.}

\item{\code{get_filter(idx)}}{

This function implements the HDF5-API function H5Pget_filter2.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_GET_FILTER2} for details.}

\item{\code{modify_filter(filter = h5const$H5Z_FILTER_DEFLATE,
  flags = h5const$H5Z_FLAG_OPTIONAL, cd_values = integer(0))}}{

This function implements the HDF5-API function H5Pmodify_filter.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_MODIFY_FILTER} for details.}

\item{\code{remove_filter(filter = h5const$H5Z_FILTER_ALL)}}{

This function implements the HDF5-API function H5Premove_filter.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_REMOVE_FILTER} for details.}

\item{\code{set_fletcher32()}}{

This function implements the HDF5-API function H5Pset_fletcher32.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_SET_FLETCHER32} for details.}

\item{\code{set_nbit()}}{

This function implements the HDF5-API function H5Pset_nbit.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_SET_NBIT} for details.}

\item{\code{set_scaleoffset(scale_type = h5const$H5Z_SO_FLOAT_DSCALE,
  scale_factor = 0)}}{

This function implements the HDF5-API function H5Pset_scaleoffset.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_SET_SCALEOFFSET} for details.}

\item{\code{set_shuffle()}}{

This function implements the HDF5-API function H5Pset_shuffle.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_SET_SHUFFLE} for details.}

\item{\code{set_szip()}}{

This function implements the HDF5-API function H5Pset_szip.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_SET_SZIP} for details.}

\item{\code{set_external(filename, offset, size)}}{

This function implements the HDF5-API function H5Pset_external.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_SET_EXTERNAL} for details.}

\item{\code{get_external_count()}}{

This function implements the HDF5-API function H5Pget_external_count.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_GET_EXTERNAL_COUNT} for details.}

\item{\code{get_external(idx)}}{

This function implements the HDF5-API function H5Pget_external.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5P_GET_EXTERNAL} for details.}
}}

\seealso{
\code{\link[=H5P]{H5P}}
}
\author{
Holger Hoefling
}