• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /**
2  * Copyright 2021 Huawei Technologies Co., Ltd
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_SOURCE_CALTECH256_NODE_H_
18 #define MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_SOURCE_CALTECH256_NODE_H_
19 
20 #include <map>
21 #include <memory>
22 #include <set>
23 #include <string>
24 #include <vector>
25 
26 #include "minddata/dataset/engine/ir/cache/dataset_cache.h"
27 #include "minddata/dataset/engine/ir/datasetops/dataset_node.h"
28 
29 namespace mindspore {
30 namespace dataset {
31 /// \class Caltech256Node.
32 /// \brief A Dataset derived class to represent Caltech256 dataset.
33 class Caltech256Node : public MappableSourceNode {
34  public:
35   /// \brief Constructor.
36   Caltech256Node(const std::string &dataset_dir, bool decode, std::shared_ptr<SamplerObj> sampler,
37                  std::shared_ptr<DatasetCache> cache);
38 
39   /// \brief Destructor.
40   ~Caltech256Node() override = default;
41 
42   /// \brief Node name getter.
43   /// \return Name of the current node.
Name()44   std::string Name() const override { return kCaltech256Node; }
45 
46   /// \brief Print the description.
47   /// \param[out] out The output stream to write output to.
48   void Print(std::ostream &out) const override;
49 
50   /// \brief Copy the node to a new object.
51   /// \return A shared pointer to the new copy.
52   std::shared_ptr<DatasetNode> Copy() override;
53 
54   /// \brief a base class override function to create the required runtime dataset op objects for this class.
55   /// \param[out] node_ops A vector containing shared pointer to the Dataset Ops that this object will create.
56   /// \return Status Status::OK() if build successfully.
57   Status Build(std::vector<std::shared_ptr<DatasetOp>> *const node_ops) override;
58 
59   /// \brief Parameters validation.
60   /// \return Status Status::OK() if all the parameters are valid.
61   Status ValidateParams() override;
62 
63   /// \brief Get the shard id of node.
64   /// \param[out] shard_id The shard id.
65   /// \return Status Status::OK() if get shard id successfully.
66   Status GetShardId(int32_t *shard_id) override;
67 
68   /// \brief Base-class override for GetDatasetSize.
69   /// \param[in] size_getter Shared pointer to DatasetSizeGetter.
70   /// \param[in] estimate This is only supported by some of the ops and it's used to speed up the process of getting
71   ///     dataset size at the expense of accuracy.
72   /// \param[out] dataset_size The size of the dataset.
73   /// \return Status of the function.
74   Status GetDatasetSize(const std::shared_ptr<DatasetSizeGetter> &size_getter, bool estimate,
75                         int64_t *dataset_size) override;
76 
77   /// \brief Getter functions.
DatasetDir()78   const std::string &DatasetDir() const { return dataset_dir_; }
Decode()79   bool Decode() const { return decode_; }
80 
81   /// \brief Get the arguments of node.
82   /// \param[out] out_json JSON string of all attributes.
83   /// \return Status of the function.
84   Status to_json(nlohmann::json *out_json) override;
85 
86 #ifndef ENABLE_ANDROID
87   /// \brief Function to read dataset in json.
88   /// \param[in] json_obj The JSON object to be deserialized.
89   /// \param[out] ds Deserialized dataset.
90   /// \return Status The status code returned.
91   static Status from_json(nlohmann::json json_obj, std::shared_ptr<DatasetNode> *ds);
92 #endif
93 
94   /// \brief Sampler getter.
95   /// \return SamplerObj of the current node.
Sampler()96   std::shared_ptr<SamplerObj> Sampler() override { return sampler_; }
97 
98   /// \brief Sampler setter.
SetSampler(std::shared_ptr<SamplerObj> sampler)99   void SetSampler(std::shared_ptr<SamplerObj> sampler) override { sampler_ = sampler; }
100 
101  private:
102   std::string dataset_dir_;
103   bool decode_;
104   std::shared_ptr<SamplerObj> sampler_;
105 };
106 }  // namespace dataset
107 }  // namespace mindspore
108 #endif  // MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_SOURCE_CALTECH256_NODE_H_
109